1"""
   2## Expressions
   3
   4Every AST node in SQLGlot is represented by a subclass of `Expression`.
   5
   6This module contains the implementation of all supported `Expression` types. Additionally,
   7it exposes a number of helper functions, which are mainly used to programmatically build
   8SQL expressions, such as `sqlglot.expressions.select`.
   9
  10----
  11"""
  12
  13from __future__ import annotations
  14
  15import datetime
  16import math
  17import numbers
  18import re
  19import textwrap
  20import typing as t
  21from collections import deque
  22from copy import deepcopy
  23from enum import auto
  24from functools import reduce
  25
  26from sqlglot.errors import ErrorLevel, ParseError
  27from sqlglot.helper import (
  28    AutoName,
  29    camel_to_snake_case,
  30    ensure_collection,
  31    ensure_list,
  32    is_int,
  33    seq_get,
  34    subclasses,
  35)
  36from sqlglot.tokens import Token
  37
  38if t.TYPE_CHECKING:
  39    from sqlglot._typing import E, Lit
  40    from sqlglot.dialects.dialect import DialectType
  41
  42    Q = t.TypeVar("Q", bound="Query")
  43
  44
  45class _Expression(type):
  46    def __new__(cls, clsname, bases, attrs):
  47        klass = super().__new__(cls, clsname, bases, attrs)
  48
  49        # When an Expression class is created, its key is automatically set to be
  50        # the lowercase version of the class' name.
  51        klass.key = clsname.lower()
  52
  53        # This is so that docstrings are not inherited in pdoc
  54        klass.__doc__ = klass.__doc__ or ""
  55
  56        return klass
  57
  58
  59SQLGLOT_META = "sqlglot.meta"
  60TABLE_PARTS = ("this", "db", "catalog")
  61
  62
  63class Expression(metaclass=_Expression):
  64    """
  65    The base class for all expressions in a syntax tree. Each Expression encapsulates any necessary
  66    context, such as its child expressions, their names (arg keys), and whether a given child expression
  67    is optional or not.
  68
  69    Attributes:
  70        key: a unique key for each class in the Expression hierarchy. This is useful for hashing
  71            and representing expressions as strings.
  72        arg_types: determines the arguments (child nodes) supported by an expression. It maps
  73            arg keys to booleans that indicate whether the corresponding args are optional.
  74        parent: a reference to the parent expression (or None, in case of root expressions).
  75        arg_key: the arg key an expression is associated with, i.e. the name its parent expression
  76            uses to refer to it.
  77        index: the index of an expression if it is inside of a list argument in its parent.
  78        comments: a list of comments that are associated with a given expression. This is used in
  79            order to preserve comments when transpiling SQL code.
  80        type: the `sqlglot.expressions.DataType` type of an expression. This is inferred by the
  81            optimizer, in order to enable some transformations that require type information.
  82        meta: a dictionary that can be used to store useful metadata for a given expression.
  83
  84    Example:
  85        >>> class Foo(Expression):
  86        ...     arg_types = {"this": True, "expression": False}
  87
  88        The above definition informs us that Foo is an Expression that requires an argument called
  89        "this" and may also optionally receive an argument called "expression".
  90
  91    Args:
  92        args: a mapping used for retrieving the arguments of an expression, given their arg keys.
  93    """
  94
  95    key = "expression"
  96    arg_types = {"this": True}
  97    __slots__ = ("args", "parent", "arg_key", "index", "comments", "_type", "_meta", "_hash")
  98
  99    def __init__(self, **args: t.Any):
 100        self.args: t.Dict[str, t.Any] = args
 101        self.parent: t.Optional[Expression] = None
 102        self.arg_key: t.Optional[str] = None
 103        self.index: t.Optional[int] = None
 104        self.comments: t.Optional[t.List[str]] = None
 105        self._type: t.Optional[DataType] = None
 106        self._meta: t.Optional[t.Dict[str, t.Any]] = None
 107        self._hash: t.Optional[int] = None
 108
 109        for arg_key, value in self.args.items():
 110            self._set_parent(arg_key, value)
 111
 112    def __eq__(self, other) -> bool:
 113        return type(self) is type(other) and hash(self) == hash(other)
 114
 115    @property
 116    def hashable_args(self) -> t.Any:
 117        return frozenset(
 118            (k, tuple(_norm_arg(a) for a in v) if type(v) is list else _norm_arg(v))
 119            for k, v in self.args.items()
 120            if not (v is None or v is False or (type(v) is list and not v))
 121        )
 122
 123    def __hash__(self) -> int:
 124        if self._hash is not None:
 125            return self._hash
 126
 127        return hash((self.__class__, self.hashable_args))
 128
 129    @property
 130    def this(self) -> t.Any:
 131        """
 132        Retrieves the argument with key "this".
 133        """
 134        return self.args.get("this")
 135
 136    @property
 137    def expression(self) -> t.Any:
 138        """
 139        Retrieves the argument with key "expression".
 140        """
 141        return self.args.get("expression")
 142
 143    @property
 144    def expressions(self) -> t.List[t.Any]:
 145        """
 146        Retrieves the argument with key "expressions".
 147        """
 148        return self.args.get("expressions") or []
 149
 150    def text(self, key) -> str:
 151        """
 152        Returns a textual representation of the argument corresponding to "key". This can only be used
 153        for args that are strings or leaf Expression instances, such as identifiers and literals.
 154        """
 155        field = self.args.get(key)
 156        if isinstance(field, str):
 157            return field
 158        if isinstance(field, (Identifier, Literal, Var)):
 159            return field.this
 160        if isinstance(field, (Star, Null)):
 161            return field.name
 162        return ""
 163
 164    @property
 165    def is_string(self) -> bool:
 166        """
 167        Checks whether a Literal expression is a string.
 168        """
 169        return isinstance(self, Literal) and self.args["is_string"]
 170
 171    @property
 172    def is_number(self) -> bool:
 173        """
 174        Checks whether a Literal expression is a number.
 175        """
 176        return isinstance(self, Literal) and not self.args["is_string"]
 177
 178    @property
 179    def is_int(self) -> bool:
 180        """
 181        Checks whether a Literal expression is an integer.
 182        """
 183        return self.is_number and is_int(self.name)
 184
 185    @property
 186    def is_star(self) -> bool:
 187        """Checks whether an expression is a star."""
 188        return isinstance(self, Star) or (isinstance(self, Column) and isinstance(self.this, Star))
 189
 190    @property
 191    def alias(self) -> str:
 192        """
 193        Returns the alias of the expression, or an empty string if it's not aliased.
 194        """
 195        if isinstance(self.args.get("alias"), TableAlias):
 196            return self.args["alias"].name
 197        return self.text("alias")
 198
 199    @property
 200    def alias_column_names(self) -> t.List[str]:
 201        table_alias = self.args.get("alias")
 202        if not table_alias:
 203            return []
 204        return [c.name for c in table_alias.args.get("columns") or []]
 205
 206    @property
 207    def name(self) -> str:
 208        return self.text("this")
 209
 210    @property
 211    def alias_or_name(self) -> str:
 212        return self.alias or self.name
 213
 214    @property
 215    def output_name(self) -> str:
 216        """
 217        Name of the output column if this expression is a selection.
 218
 219        If the Expression has no output name, an empty string is returned.
 220
 221        Example:
 222            >>> from sqlglot import parse_one
 223            >>> parse_one("SELECT a").expressions[0].output_name
 224            'a'
 225            >>> parse_one("SELECT b AS c").expressions[0].output_name
 226            'c'
 227            >>> parse_one("SELECT 1 + 2").expressions[0].output_name
 228            ''
 229        """
 230        return ""
 231
 232    @property
 233    def type(self) -> t.Optional[DataType]:
 234        return self._type
 235
 236    @type.setter
 237    def type(self, dtype: t.Optional[DataType | DataType.Type | str]) -> None:
 238        if dtype and not isinstance(dtype, DataType):
 239            dtype = DataType.build(dtype)
 240        self._type = dtype  # type: ignore
 241
 242    def is_type(self, *dtypes) -> bool:
 243        return self.type is not None and self.type.is_type(*dtypes)
 244
 245    def is_leaf(self) -> bool:
 246        return not any(isinstance(v, (Expression, list)) for v in self.args.values())
 247
 248    @property
 249    def meta(self) -> t.Dict[str, t.Any]:
 250        if self._meta is None:
 251            self._meta = {}
 252        return self._meta
 253
 254    def __deepcopy__(self, memo):
 255        root = self.__class__()
 256        stack = [(self, root)]
 257
 258        while stack:
 259            node, copy = stack.pop()
 260
 261            if node.comments is not None:
 262                copy.comments = deepcopy(node.comments)
 263            if node._type is not None:
 264                copy._type = deepcopy(node._type)
 265            if node._meta is not None:
 266                copy._meta = deepcopy(node._meta)
 267            if node._hash is not None:
 268                copy._hash = node._hash
 269
 270            for k, vs in node.args.items():
 271                if hasattr(vs, "parent"):
 272                    stack.append((vs, vs.__class__()))
 273                    copy.set(k, stack[-1][-1])
 274                elif type(vs) is list:
 275                    copy.args[k] = []
 276
 277                    for v in vs:
 278                        if hasattr(v, "parent"):
 279                            stack.append((v, v.__class__()))
 280                            copy.append(k, stack[-1][-1])
 281                        else:
 282                            copy.append(k, v)
 283                else:
 284                    copy.args[k] = vs
 285
 286        return root
 287
 288    def copy(self):
 289        """
 290        Returns a deep copy of the expression.
 291        """
 292        return deepcopy(self)
 293
 294    def add_comments(self, comments: t.Optional[t.List[str]]) -> None:
 295        if self.comments is None:
 296            self.comments = []
 297        if comments:
 298            for comment in comments:
 299                _, *meta = comment.split(SQLGLOT_META)
 300                if meta:
 301                    for kv in "".join(meta).split(","):
 302                        k, *v = kv.split("=")
 303                        value = v[0].strip() if v else True
 304                        self.meta[k.strip()] = value
 305                self.comments.append(comment)
 306
 307    def append(self, arg_key: str, value: t.Any) -> None:
 308        """
 309        Appends value to arg_key if it's a list or sets it as a new list.
 310
 311        Args:
 312            arg_key (str): name of the list expression arg
 313            value (Any): value to append to the list
 314        """
 315        if type(self.args.get(arg_key)) is not list:
 316            self.args[arg_key] = []
 317        self._set_parent(arg_key, value)
 318        values = self.args[arg_key]
 319        if hasattr(value, "parent"):
 320            value.index = len(values)
 321        values.append(value)
 322
 323    def set(self, arg_key: str, value: t.Any, index: t.Optional[int] = None) -> None:
 324        """
 325        Sets arg_key to value.
 326
 327        Args:
 328            arg_key: name of the expression arg.
 329            value: value to set the arg to.
 330            index: if the arg is a list, this specifies what position to add the value in it.
 331        """
 332        if index is not None:
 333            expressions = self.args.get(arg_key) or []
 334
 335            if seq_get(expressions, index) is None:
 336                return
 337            if value is None:
 338                expressions.pop(index)
 339                for v in expressions[index:]:
 340                    v.index = v.index - 1
 341                return
 342
 343            if isinstance(value, list):
 344                expressions.pop(index)
 345                expressions[index:index] = value
 346            else:
 347                expressions[index] = value
 348
 349            value = expressions
 350        elif value is None:
 351            self.args.pop(arg_key, None)
 352            return
 353
 354        self.args[arg_key] = value
 355        self._set_parent(arg_key, value, index)
 356
 357    def _set_parent(self, arg_key: str, value: t.Any, index: t.Optional[int] = None) -> None:
 358        if hasattr(value, "parent"):
 359            value.parent = self
 360            value.arg_key = arg_key
 361            value.index = index
 362        elif type(value) is list:
 363            for index, v in enumerate(value):
 364                if hasattr(v, "parent"):
 365                    v.parent = self
 366                    v.arg_key = arg_key
 367                    v.index = index
 368
 369    @property
 370    def depth(self) -> int:
 371        """
 372        Returns the depth of this tree.
 373        """
 374        if self.parent:
 375            return self.parent.depth + 1
 376        return 0
 377
 378    def iter_expressions(self, reverse: bool = False) -> t.Iterator[Expression]:
 379        """Yields the key and expression for all arguments, exploding list args."""
 380        # remove tuple when python 3.7 is deprecated
 381        for vs in reversed(tuple(self.args.values())) if reverse else self.args.values():
 382            if type(vs) is list:
 383                for v in reversed(vs) if reverse else vs:
 384                    if hasattr(v, "parent"):
 385                        yield v
 386            else:
 387                if hasattr(vs, "parent"):
 388                    yield vs
 389
 390    def find(self, *expression_types: t.Type[E], bfs: bool = True) -> t.Optional[E]:
 391        """
 392        Returns the first node in this tree which matches at least one of
 393        the specified types.
 394
 395        Args:
 396            expression_types: the expression type(s) to match.
 397            bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
 398
 399        Returns:
 400            The node which matches the criteria or None if no such node was found.
 401        """
 402        return next(self.find_all(*expression_types, bfs=bfs), None)
 403
 404    def find_all(self, *expression_types: t.Type[E], bfs: bool = True) -> t.Iterator[E]:
 405        """
 406        Returns a generator object which visits all nodes in this tree and only
 407        yields those that match at least one of the specified expression types.
 408
 409        Args:
 410            expression_types: the expression type(s) to match.
 411            bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
 412
 413        Returns:
 414            The generator object.
 415        """
 416        for expression in self.walk(bfs=bfs):
 417            if isinstance(expression, expression_types):
 418                yield expression
 419
 420    def find_ancestor(self, *expression_types: t.Type[E]) -> t.Optional[E]:
 421        """
 422        Returns a nearest parent matching expression_types.
 423
 424        Args:
 425            expression_types: the expression type(s) to match.
 426
 427        Returns:
 428            The parent node.
 429        """
 430        ancestor = self.parent
 431        while ancestor and not isinstance(ancestor, expression_types):
 432            ancestor = ancestor.parent
 433        return ancestor  # type: ignore
 434
 435    @property
 436    def parent_select(self) -> t.Optional[Select]:
 437        """
 438        Returns the parent select statement.
 439        """
 440        return self.find_ancestor(Select)
 441
 442    @property
 443    def same_parent(self) -> bool:
 444        """Returns if the parent is the same class as itself."""
 445        return type(self.parent) is self.__class__
 446
 447    def root(self) -> Expression:
 448        """
 449        Returns the root expression of this tree.
 450        """
 451        expression = self
 452        while expression.parent:
 453            expression = expression.parent
 454        return expression
 455
 456    def walk(
 457        self, bfs: bool = True, prune: t.Optional[t.Callable[[Expression], bool]] = None
 458    ) -> t.Iterator[Expression]:
 459        """
 460        Returns a generator object which visits all nodes in this tree.
 461
 462        Args:
 463            bfs (bool): if set to True the BFS traversal order will be applied,
 464                otherwise the DFS traversal will be used instead.
 465            prune ((node, parent, arg_key) -> bool): callable that returns True if
 466                the generator should stop traversing this branch of the tree.
 467
 468        Returns:
 469            the generator object.
 470        """
 471        if bfs:
 472            yield from self.bfs(prune=prune)
 473        else:
 474            yield from self.dfs(prune=prune)
 475
 476    def dfs(
 477        self, prune: t.Optional[t.Callable[[Expression], bool]] = None
 478    ) -> t.Iterator[Expression]:
 479        """
 480        Returns a generator object which visits all nodes in this tree in
 481        the DFS (Depth-first) order.
 482
 483        Returns:
 484            The generator object.
 485        """
 486        stack = [self]
 487
 488        while stack:
 489            node = stack.pop()
 490
 491            yield node
 492
 493            if prune and prune(node):
 494                continue
 495
 496            for v in node.iter_expressions(reverse=True):
 497                stack.append(v)
 498
 499    def bfs(
 500        self, prune: t.Optional[t.Callable[[Expression], bool]] = None
 501    ) -> t.Iterator[Expression]:
 502        """
 503        Returns a generator object which visits all nodes in this tree in
 504        the BFS (Breadth-first) order.
 505
 506        Returns:
 507            The generator object.
 508        """
 509        queue = deque([self])
 510
 511        while queue:
 512            node = queue.popleft()
 513
 514            yield node
 515
 516            if prune and prune(node):
 517                continue
 518
 519            for v in node.iter_expressions():
 520                queue.append(v)
 521
 522    def unnest(self):
 523        """
 524        Returns the first non parenthesis child or self.
 525        """
 526        expression = self
 527        while type(expression) is Paren:
 528            expression = expression.this
 529        return expression
 530
 531    def unalias(self):
 532        """
 533        Returns the inner expression if this is an Alias.
 534        """
 535        if isinstance(self, Alias):
 536            return self.this
 537        return self
 538
 539    def unnest_operands(self):
 540        """
 541        Returns unnested operands as a tuple.
 542        """
 543        return tuple(arg.unnest() for arg in self.iter_expressions())
 544
 545    def flatten(self, unnest=True):
 546        """
 547        Returns a generator which yields child nodes whose parents are the same class.
 548
 549        A AND B AND C -> [A, B, C]
 550        """
 551        for node in self.dfs(prune=lambda n: n.parent and type(n) is not self.__class__):
 552            if type(node) is not self.__class__:
 553                yield node.unnest() if unnest and not isinstance(node, Subquery) else node
 554
 555    def __str__(self) -> str:
 556        return self.sql()
 557
 558    def __repr__(self) -> str:
 559        return _to_s(self)
 560
 561    def to_s(self) -> str:
 562        """
 563        Same as __repr__, but includes additional information which can be useful
 564        for debugging, like empty or missing args and the AST nodes' object IDs.
 565        """
 566        return _to_s(self, verbose=True)
 567
 568    def sql(self, dialect: DialectType = None, **opts) -> str:
 569        """
 570        Returns SQL string representation of this tree.
 571
 572        Args:
 573            dialect: the dialect of the output SQL string (eg. "spark", "hive", "presto", "mysql").
 574            opts: other `sqlglot.generator.Generator` options.
 575
 576        Returns:
 577            The SQL string.
 578        """
 579        from sqlglot.dialects import Dialect
 580
 581        return Dialect.get_or_raise(dialect).generate(self, **opts)
 582
 583    def transform(self, fun: t.Callable, *args: t.Any, copy: bool = True, **kwargs) -> Expression:
 584        """
 585        Visits all tree nodes (excluding already transformed ones)
 586        and applies the given transformation function to each node.
 587
 588        Args:
 589            fun (function): a function which takes a node as an argument and returns a
 590                new transformed node or the same node without modifications. If the function
 591                returns None, then the corresponding node will be removed from the syntax tree.
 592            copy (bool): if set to True a new tree instance is constructed, otherwise the tree is
 593                modified in place.
 594
 595        Returns:
 596            The transformed tree.
 597        """
 598        root = None
 599        new_node = None
 600
 601        for node in (self.copy() if copy else self).dfs(prune=lambda n: n is not new_node):
 602            parent, arg_key, index = node.parent, node.arg_key, node.index
 603            new_node = fun(node, *args, **kwargs)
 604
 605            if not root:
 606                root = new_node
 607            elif new_node is not node:
 608                parent.set(arg_key, new_node, index)
 609
 610        assert root
 611        return root.assert_is(Expression)
 612
 613    @t.overload
 614    def replace(self, expression: E) -> E: ...
 615
 616    @t.overload
 617    def replace(self, expression: None) -> None: ...
 618
 619    def replace(self, expression):
 620        """
 621        Swap out this expression with a new expression.
 622
 623        For example::
 624
 625            >>> tree = Select().select("x").from_("tbl")
 626            >>> tree.find(Column).replace(column("y"))
 627            Column(
 628              this=Identifier(this=y, quoted=False))
 629            >>> tree.sql()
 630            'SELECT y FROM tbl'
 631
 632        Args:
 633            expression: new node
 634
 635        Returns:
 636            The new expression or expressions.
 637        """
 638        parent = self.parent
 639
 640        if not parent or parent is expression:
 641            return expression
 642
 643        key = self.arg_key
 644        value = parent.args.get(key)
 645
 646        if type(expression) is list and isinstance(value, Expression):
 647            # We are trying to replace an Expression with a list, so it's assumed that
 648            # the intention was to really replace the parent of this expression.
 649            value.parent.replace(expression)
 650        else:
 651            parent.set(key, expression, self.index)
 652
 653        if expression is not self:
 654            self.parent = None
 655            self.arg_key = None
 656            self.index = None
 657
 658        return expression
 659
 660    def pop(self: E) -> E:
 661        """
 662        Remove this expression from its AST.
 663
 664        Returns:
 665            The popped expression.
 666        """
 667        self.replace(None)
 668        return self
 669
 670    def assert_is(self, type_: t.Type[E]) -> E:
 671        """
 672        Assert that this `Expression` is an instance of `type_`.
 673
 674        If it is NOT an instance of `type_`, this raises an assertion error.
 675        Otherwise, this returns this expression.
 676
 677        Examples:
 678            This is useful for type security in chained expressions:
 679
 680            >>> import sqlglot
 681            >>> sqlglot.parse_one("SELECT x from y").assert_is(Select).select("z").sql()
 682            'SELECT x, z FROM y'
 683        """
 684        if not isinstance(self, type_):
 685            raise AssertionError(f"{self} is not {type_}.")
 686        return self
 687
 688    def error_messages(self, args: t.Optional[t.Sequence] = None) -> t.List[str]:
 689        """
 690        Checks if this expression is valid (e.g. all mandatory args are set).
 691
 692        Args:
 693            args: a sequence of values that were used to instantiate a Func expression. This is used
 694                to check that the provided arguments don't exceed the function argument limit.
 695
 696        Returns:
 697            A list of error messages for all possible errors that were found.
 698        """
 699        errors: t.List[str] = []
 700
 701        for k in self.args:
 702            if k not in self.arg_types:
 703                errors.append(f"Unexpected keyword: '{k}' for {self.__class__}")
 704        for k, mandatory in self.arg_types.items():
 705            v = self.args.get(k)
 706            if mandatory and (v is None or (isinstance(v, list) and not v)):
 707                errors.append(f"Required keyword: '{k}' missing for {self.__class__}")
 708
 709        if (
 710            args
 711            and isinstance(self, Func)
 712            and len(args) > len(self.arg_types)
 713            and not self.is_var_len_args
 714        ):
 715            errors.append(
 716                f"The number of provided arguments ({len(args)}) is greater than "
 717                f"the maximum number of supported arguments ({len(self.arg_types)})"
 718            )
 719
 720        return errors
 721
 722    def dump(self):
 723        """
 724        Dump this Expression to a JSON-serializable dict.
 725        """
 726        from sqlglot.serde import dump
 727
 728        return dump(self)
 729
 730    @classmethod
 731    def load(cls, obj):
 732        """
 733        Load a dict (as returned by `Expression.dump`) into an Expression instance.
 734        """
 735        from sqlglot.serde import load
 736
 737        return load(obj)
 738
 739    def and_(
 740        self,
 741        *expressions: t.Optional[ExpOrStr],
 742        dialect: DialectType = None,
 743        copy: bool = True,
 744        **opts,
 745    ) -> Condition:
 746        """
 747        AND this condition with one or multiple expressions.
 748
 749        Example:
 750            >>> condition("x=1").and_("y=1").sql()
 751            'x = 1 AND y = 1'
 752
 753        Args:
 754            *expressions: the SQL code strings to parse.
 755                If an `Expression` instance is passed, it will be used as-is.
 756            dialect: the dialect used to parse the input expression.
 757            copy: whether to copy the involved expressions (only applies to Expressions).
 758            opts: other options to use to parse the input expressions.
 759
 760        Returns:
 761            The new And condition.
 762        """
 763        return and_(self, *expressions, dialect=dialect, copy=copy, **opts)
 764
 765    def or_(
 766        self,
 767        *expressions: t.Optional[ExpOrStr],
 768        dialect: DialectType = None,
 769        copy: bool = True,
 770        **opts,
 771    ) -> Condition:
 772        """
 773        OR this condition with one or multiple expressions.
 774
 775        Example:
 776            >>> condition("x=1").or_("y=1").sql()
 777            'x = 1 OR y = 1'
 778
 779        Args:
 780            *expressions: the SQL code strings to parse.
 781                If an `Expression` instance is passed, it will be used as-is.
 782            dialect: the dialect used to parse the input expression.
 783            copy: whether to copy the involved expressions (only applies to Expressions).
 784            opts: other options to use to parse the input expressions.
 785
 786        Returns:
 787            The new Or condition.
 788        """
 789        return or_(self, *expressions, dialect=dialect, copy=copy, **opts)
 790
 791    def not_(self, copy: bool = True):
 792        """
 793        Wrap this condition with NOT.
 794
 795        Example:
 796            >>> condition("x=1").not_().sql()
 797            'NOT x = 1'
 798
 799        Args:
 800            copy: whether to copy this object.
 801
 802        Returns:
 803            The new Not instance.
 804        """
 805        return not_(self, copy=copy)
 806
 807    def as_(
 808        self,
 809        alias: str | Identifier,
 810        quoted: t.Optional[bool] = None,
 811        dialect: DialectType = None,
 812        copy: bool = True,
 813        **opts,
 814    ) -> Alias:
 815        return alias_(self, alias, quoted=quoted, dialect=dialect, copy=copy, **opts)
 816
 817    def _binop(self, klass: t.Type[E], other: t.Any, reverse: bool = False) -> E:
 818        this = self.copy()
 819        other = convert(other, copy=True)
 820        if not isinstance(this, klass) and not isinstance(other, klass):
 821            this = _wrap(this, Binary)
 822            other = _wrap(other, Binary)
 823        if reverse:
 824            return klass(this=other, expression=this)
 825        return klass(this=this, expression=other)
 826
 827    def __getitem__(self, other: ExpOrStr | t.Tuple[ExpOrStr]) -> Bracket:
 828        return Bracket(
 829            this=self.copy(), expressions=[convert(e, copy=True) for e in ensure_list(other)]
 830        )
 831
 832    def __iter__(self) -> t.Iterator:
 833        if "expressions" in self.arg_types:
 834            return iter(self.args.get("expressions") or [])
 835        # We define this because __getitem__ converts Expression into an iterable, which is
 836        # problematic because one can hit infinite loops if they do "for x in some_expr: ..."
 837        # See: https://peps.python.org/pep-0234/
 838        raise TypeError(f"'{self.__class__.__name__}' object is not iterable")
 839
 840    def isin(
 841        self,
 842        *expressions: t.Any,
 843        query: t.Optional[ExpOrStr] = None,
 844        unnest: t.Optional[ExpOrStr] | t.Collection[ExpOrStr] = None,
 845        copy: bool = True,
 846        **opts,
 847    ) -> In:
 848        return In(
 849            this=maybe_copy(self, copy),
 850            expressions=[convert(e, copy=copy) for e in expressions],
 851            query=maybe_parse(query, copy=copy, **opts) if query else None,
 852            unnest=(
 853                Unnest(
 854                    expressions=[
 855                        maybe_parse(t.cast(ExpOrStr, e), copy=copy, **opts)
 856                        for e in ensure_list(unnest)
 857                    ]
 858                )
 859                if unnest
 860                else None
 861            ),
 862        )
 863
 864    def between(self, low: t.Any, high: t.Any, copy: bool = True, **opts) -> Between:
 865        return Between(
 866            this=maybe_copy(self, copy),
 867            low=convert(low, copy=copy, **opts),
 868            high=convert(high, copy=copy, **opts),
 869        )
 870
 871    def is_(self, other: ExpOrStr) -> Is:
 872        return self._binop(Is, other)
 873
 874    def like(self, other: ExpOrStr) -> Like:
 875        return self._binop(Like, other)
 876
 877    def ilike(self, other: ExpOrStr) -> ILike:
 878        return self._binop(ILike, other)
 879
 880    def eq(self, other: t.Any) -> EQ:
 881        return self._binop(EQ, other)
 882
 883    def neq(self, other: t.Any) -> NEQ:
 884        return self._binop(NEQ, other)
 885
 886    def rlike(self, other: ExpOrStr) -> RegexpLike:
 887        return self._binop(RegexpLike, other)
 888
 889    def div(self, other: ExpOrStr, typed: bool = False, safe: bool = False) -> Div:
 890        div = self._binop(Div, other)
 891        div.args["typed"] = typed
 892        div.args["safe"] = safe
 893        return div
 894
 895    def asc(self, nulls_first: bool = True) -> Ordered:
 896        return Ordered(this=self.copy(), nulls_first=nulls_first)
 897
 898    def desc(self, nulls_first: bool = False) -> Ordered:
 899        return Ordered(this=self.copy(), desc=True, nulls_first=nulls_first)
 900
 901    def __lt__(self, other: t.Any) -> LT:
 902        return self._binop(LT, other)
 903
 904    def __le__(self, other: t.Any) -> LTE:
 905        return self._binop(LTE, other)
 906
 907    def __gt__(self, other: t.Any) -> GT:
 908        return self._binop(GT, other)
 909
 910    def __ge__(self, other: t.Any) -> GTE:
 911        return self._binop(GTE, other)
 912
 913    def __add__(self, other: t.Any) -> Add:
 914        return self._binop(Add, other)
 915
 916    def __radd__(self, other: t.Any) -> Add:
 917        return self._binop(Add, other, reverse=True)
 918
 919    def __sub__(self, other: t.Any) -> Sub:
 920        return self._binop(Sub, other)
 921
 922    def __rsub__(self, other: t.Any) -> Sub:
 923        return self._binop(Sub, other, reverse=True)
 924
 925    def __mul__(self, other: t.Any) -> Mul:
 926        return self._binop(Mul, other)
 927
 928    def __rmul__(self, other: t.Any) -> Mul:
 929        return self._binop(Mul, other, reverse=True)
 930
 931    def __truediv__(self, other: t.Any) -> Div:
 932        return self._binop(Div, other)
 933
 934    def __rtruediv__(self, other: t.Any) -> Div:
 935        return self._binop(Div, other, reverse=True)
 936
 937    def __floordiv__(self, other: t.Any) -> IntDiv:
 938        return self._binop(IntDiv, other)
 939
 940    def __rfloordiv__(self, other: t.Any) -> IntDiv:
 941        return self._binop(IntDiv, other, reverse=True)
 942
 943    def __mod__(self, other: t.Any) -> Mod:
 944        return self._binop(Mod, other)
 945
 946    def __rmod__(self, other: t.Any) -> Mod:
 947        return self._binop(Mod, other, reverse=True)
 948
 949    def __pow__(self, other: t.Any) -> Pow:
 950        return self._binop(Pow, other)
 951
 952    def __rpow__(self, other: t.Any) -> Pow:
 953        return self._binop(Pow, other, reverse=True)
 954
 955    def __and__(self, other: t.Any) -> And:
 956        return self._binop(And, other)
 957
 958    def __rand__(self, other: t.Any) -> And:
 959        return self._binop(And, other, reverse=True)
 960
 961    def __or__(self, other: t.Any) -> Or:
 962        return self._binop(Or, other)
 963
 964    def __ror__(self, other: t.Any) -> Or:
 965        return self._binop(Or, other, reverse=True)
 966
 967    def __neg__(self) -> Neg:
 968        return Neg(this=_wrap(self.copy(), Binary))
 969
 970    def __invert__(self) -> Not:
 971        return not_(self.copy())
 972
 973
 974IntoType = t.Union[
 975    str,
 976    t.Type[Expression],
 977    t.Collection[t.Union[str, t.Type[Expression]]],
 978]
 979ExpOrStr = t.Union[str, Expression]
 980
 981
 982class Condition(Expression):
 983    """Logical conditions like x AND y, or simply x"""
 984
 985
 986class Predicate(Condition):
 987    """Relationships like x = y, x > 1, x >= y."""
 988
 989
 990class DerivedTable(Expression):
 991    @property
 992    def selects(self) -> t.List[Expression]:
 993        return self.this.selects if isinstance(self.this, Query) else []
 994
 995    @property
 996    def named_selects(self) -> t.List[str]:
 997        return [select.output_name for select in self.selects]
 998
 999
1000class Query(Expression):
1001    def subquery(self, alias: t.Optional[ExpOrStr] = None, copy: bool = True) -> Subquery:
1002        """
1003        Returns a `Subquery` that wraps around this query.
1004
1005        Example:
1006            >>> subquery = Select().select("x").from_("tbl").subquery()
1007            >>> Select().select("x").from_(subquery).sql()
1008            'SELECT x FROM (SELECT x FROM tbl)'
1009
1010        Args:
1011            alias: an optional alias for the subquery.
1012            copy: if `False`, modify this expression instance in-place.
1013        """
1014        instance = maybe_copy(self, copy)
1015        if not isinstance(alias, Expression):
1016            alias = TableAlias(this=to_identifier(alias)) if alias else None
1017
1018        return Subquery(this=instance, alias=alias)
1019
1020    def limit(
1021        self, expression: ExpOrStr | int, dialect: DialectType = None, copy: bool = True, **opts
1022    ) -> Select:
1023        """
1024        Adds a LIMIT clause to this query.
1025
1026        Example:
1027            >>> select("1").union(select("1")).limit(1).sql()
1028            'SELECT * FROM (SELECT 1 UNION SELECT 1) AS _l_0 LIMIT 1'
1029
1030        Args:
1031            expression: the SQL code string to parse.
1032                This can also be an integer.
1033                If a `Limit` instance is passed, it will be used as-is.
1034                If another `Expression` instance is passed, it will be wrapped in a `Limit`.
1035            dialect: the dialect used to parse the input expression.
1036            copy: if `False`, modify this expression instance in-place.
1037            opts: other options to use to parse the input expressions.
1038
1039        Returns:
1040            A limited Select expression.
1041        """
1042        return (
1043            select("*")
1044            .from_(self.subquery(alias="_l_0", copy=copy))
1045            .limit(expression, dialect=dialect, copy=False, **opts)
1046        )
1047
1048    @property
1049    def ctes(self) -> t.List[CTE]:
1050        """Returns a list of all the CTEs attached to this query."""
1051        with_ = self.args.get("with")
1052        return with_.expressions if with_ else []
1053
1054    @property
1055    def selects(self) -> t.List[Expression]:
1056        """Returns the query's projections."""
1057        raise NotImplementedError("Query objects must implement `selects`")
1058
1059    @property
1060    def named_selects(self) -> t.List[str]:
1061        """Returns the output names of the query's projections."""
1062        raise NotImplementedError("Query objects must implement `named_selects`")
1063
1064    def select(
1065        self: Q,
1066        *expressions: t.Optional[ExpOrStr],
1067        append: bool = True,
1068        dialect: DialectType = None,
1069        copy: bool = True,
1070        **opts,
1071    ) -> Q:
1072        """
1073        Append to or set the SELECT expressions.
1074
1075        Example:
1076            >>> Select().select("x", "y").sql()
1077            'SELECT x, y'
1078
1079        Args:
1080            *expressions: the SQL code strings to parse.
1081                If an `Expression` instance is passed, it will be used as-is.
1082            append: if `True`, add to any existing expressions.
1083                Otherwise, this resets the expressions.
1084            dialect: the dialect used to parse the input expressions.
1085            copy: if `False`, modify this expression instance in-place.
1086            opts: other options to use to parse the input expressions.
1087
1088        Returns:
1089            The modified Query expression.
1090        """
1091        raise NotImplementedError("Query objects must implement `select`")
1092
1093    def with_(
1094        self: Q,
1095        alias: ExpOrStr,
1096        as_: ExpOrStr,
1097        recursive: t.Optional[bool] = None,
1098        append: bool = True,
1099        dialect: DialectType = None,
1100        copy: bool = True,
1101        **opts,
1102    ) -> Q:
1103        """
1104        Append to or set the common table expressions.
1105
1106        Example:
1107            >>> Select().with_("tbl2", as_="SELECT * FROM tbl").select("x").from_("tbl2").sql()
1108            'WITH tbl2 AS (SELECT * FROM tbl) SELECT x FROM tbl2'
1109
1110        Args:
1111            alias: the SQL code string to parse as the table name.
1112                If an `Expression` instance is passed, this is used as-is.
1113            as_: the SQL code string to parse as the table expression.
1114                If an `Expression` instance is passed, it will be used as-is.
1115            recursive: set the RECURSIVE part of the expression. Defaults to `False`.
1116            append: if `True`, add to any existing expressions.
1117                Otherwise, this resets the expressions.
1118            dialect: the dialect used to parse the input expression.
1119            copy: if `False`, modify this expression instance in-place.
1120            opts: other options to use to parse the input expressions.
1121
1122        Returns:
1123            The modified expression.
1124        """
1125        return _apply_cte_builder(
1126            self, alias, as_, recursive=recursive, append=append, dialect=dialect, copy=copy, **opts
1127        )
1128
1129    def union(
1130        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1131    ) -> Union:
1132        """
1133        Builds a UNION expression.
1134
1135        Example:
1136            >>> import sqlglot
1137            >>> sqlglot.parse_one("SELECT * FROM foo").union("SELECT * FROM bla").sql()
1138            'SELECT * FROM foo UNION SELECT * FROM bla'
1139
1140        Args:
1141            expression: the SQL code string.
1142                If an `Expression` instance is passed, it will be used as-is.
1143            distinct: set the DISTINCT flag if and only if this is true.
1144            dialect: the dialect used to parse the input expression.
1145            opts: other options to use to parse the input expressions.
1146
1147        Returns:
1148            The new Union expression.
1149        """
1150        return union(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)
1151
1152    def intersect(
1153        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1154    ) -> Intersect:
1155        """
1156        Builds an INTERSECT expression.
1157
1158        Example:
1159            >>> import sqlglot
1160            >>> sqlglot.parse_one("SELECT * FROM foo").intersect("SELECT * FROM bla").sql()
1161            'SELECT * FROM foo INTERSECT SELECT * FROM bla'
1162
1163        Args:
1164            expression: the SQL code string.
1165                If an `Expression` instance is passed, it will be used as-is.
1166            distinct: set the DISTINCT flag if and only if this is true.
1167            dialect: the dialect used to parse the input expression.
1168            opts: other options to use to parse the input expressions.
1169
1170        Returns:
1171            The new Intersect expression.
1172        """
1173        return intersect(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)
1174
1175    def except_(
1176        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1177    ) -> Except:
1178        """
1179        Builds an EXCEPT expression.
1180
1181        Example:
1182            >>> import sqlglot
1183            >>> sqlglot.parse_one("SELECT * FROM foo").except_("SELECT * FROM bla").sql()
1184            'SELECT * FROM foo EXCEPT SELECT * FROM bla'
1185
1186        Args:
1187            expression: the SQL code string.
1188                If an `Expression` instance is passed, it will be used as-is.
1189            distinct: set the DISTINCT flag if and only if this is true.
1190            dialect: the dialect used to parse the input expression.
1191            opts: other options to use to parse the input expressions.
1192
1193        Returns:
1194            The new Except expression.
1195        """
1196        return except_(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)
1197
1198
1199class UDTF(DerivedTable):
1200    @property
1201    def selects(self) -> t.List[Expression]:
1202        alias = self.args.get("alias")
1203        return alias.columns if alias else []
1204
1205
1206class Cache(Expression):
1207    arg_types = {
1208        "this": True,
1209        "lazy": False,
1210        "options": False,
1211        "expression": False,
1212    }
1213
1214
1215class Uncache(Expression):
1216    arg_types = {"this": True, "exists": False}
1217
1218
1219class Refresh(Expression):
1220    pass
1221
1222
1223class DDL(Expression):
1224    @property
1225    def ctes(self) -> t.List[CTE]:
1226        """Returns a list of all the CTEs attached to this statement."""
1227        with_ = self.args.get("with")
1228        return with_.expressions if with_ else []
1229
1230    @property
1231    def selects(self) -> t.List[Expression]:
1232        """If this statement contains a query (e.g. a CTAS), this returns the query's projections."""
1233        return self.expression.selects if isinstance(self.expression, Query) else []
1234
1235    @property
1236    def named_selects(self) -> t.List[str]:
1237        """
1238        If this statement contains a query (e.g. a CTAS), this returns the output
1239        names of the query's projections.
1240        """
1241        return self.expression.named_selects if isinstance(self.expression, Query) else []
1242
1243
1244class DML(Expression):
1245    def returning(
1246        self,
1247        expression: ExpOrStr,
1248        dialect: DialectType = None,
1249        copy: bool = True,
1250        **opts,
1251    ) -> DML:
1252        """
1253        Set the RETURNING expression. Not supported by all dialects.
1254
1255        Example:
1256            >>> delete("tbl").returning("*", dialect="postgres").sql()
1257            'DELETE FROM tbl RETURNING *'
1258
1259        Args:
1260            expression: the SQL code strings to parse.
1261                If an `Expression` instance is passed, it will be used as-is.
1262            dialect: the dialect used to parse the input expressions.
1263            copy: if `False`, modify this expression instance in-place.
1264            opts: other options to use to parse the input expressions.
1265
1266        Returns:
1267            Delete: the modified expression.
1268        """
1269        return _apply_builder(
1270            expression=expression,
1271            instance=self,
1272            arg="returning",
1273            prefix="RETURNING",
1274            dialect=dialect,
1275            copy=copy,
1276            into=Returning,
1277            **opts,
1278        )
1279
1280
1281class Create(DDL):
1282    arg_types = {
1283        "with": False,
1284        "this": True,
1285        "kind": True,
1286        "expression": False,
1287        "exists": False,
1288        "properties": False,
1289        "replace": False,
1290        "unique": False,
1291        "indexes": False,
1292        "no_schema_binding": False,
1293        "begin": False,
1294        "end": False,
1295        "clone": False,
1296    }
1297
1298    @property
1299    def kind(self) -> t.Optional[str]:
1300        kind = self.args.get("kind")
1301        return kind and kind.upper()
1302
1303
1304class SequenceProperties(Expression):
1305    arg_types = {
1306        "increment": False,
1307        "minvalue": False,
1308        "maxvalue": False,
1309        "cache": False,
1310        "start": False,
1311        "owned": False,
1312        "options": False,
1313    }
1314
1315
1316class TruncateTable(Expression):
1317    arg_types = {
1318        "expressions": True,
1319        "is_database": False,
1320        "exists": False,
1321        "only": False,
1322        "cluster": False,
1323        "identity": False,
1324        "option": False,
1325        "partition": False,
1326    }
1327
1328
1329# https://docs.snowflake.com/en/sql-reference/sql/create-clone
1330# https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_clone_statement
1331# https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_copy
1332class Clone(Expression):
1333    arg_types = {"this": True, "shallow": False, "copy": False}
1334
1335
1336class Describe(Expression):
1337    arg_types = {"this": True, "extended": False, "kind": False, "expressions": False}
1338
1339
1340class Kill(Expression):
1341    arg_types = {"this": True, "kind": False}
1342
1343
1344class Pragma(Expression):
1345    pass
1346
1347
1348class Set(Expression):
1349    arg_types = {"expressions": False, "unset": False, "tag": False}
1350
1351
1352class Heredoc(Expression):
1353    arg_types = {"this": True, "tag": False}
1354
1355
1356class SetItem(Expression):
1357    arg_types = {
1358        "this": False,
1359        "expressions": False,
1360        "kind": False,
1361        "collate": False,  # MySQL SET NAMES statement
1362        "global": False,
1363    }
1364
1365
1366class Show(Expression):
1367    arg_types = {
1368        "this": True,
1369        "history": False,
1370        "terse": False,
1371        "target": False,
1372        "offset": False,
1373        "starts_with": False,
1374        "limit": False,
1375        "from": False,
1376        "like": False,
1377        "where": False,
1378        "db": False,
1379        "scope": False,
1380        "scope_kind": False,
1381        "full": False,
1382        "mutex": False,
1383        "query": False,
1384        "channel": False,
1385        "global": False,
1386        "log": False,
1387        "position": False,
1388        "types": False,
1389    }
1390
1391
1392class UserDefinedFunction(Expression):
1393    arg_types = {"this": True, "expressions": False, "wrapped": False}
1394
1395
1396class CharacterSet(Expression):
1397    arg_types = {"this": True, "default": False}
1398
1399
1400class With(Expression):
1401    arg_types = {"expressions": True, "recursive": False}
1402
1403    @property
1404    def recursive(self) -> bool:
1405        return bool(self.args.get("recursive"))
1406
1407
1408class WithinGroup(Expression):
1409    arg_types = {"this": True, "expression": False}
1410
1411
1412# clickhouse supports scalar ctes
1413# https://clickhouse.com/docs/en/sql-reference/statements/select/with
1414class CTE(DerivedTable):
1415    arg_types = {
1416        "this": True,
1417        "alias": True,
1418        "scalar": False,
1419        "materialized": False,
1420    }
1421
1422
1423class TableAlias(Expression):
1424    arg_types = {"this": False, "columns": False}
1425
1426    @property
1427    def columns(self):
1428        return self.args.get("columns") or []
1429
1430
1431class BitString(Condition):
1432    pass
1433
1434
1435class HexString(Condition):
1436    pass
1437
1438
1439class ByteString(Condition):
1440    pass
1441
1442
1443class RawString(Condition):
1444    pass
1445
1446
1447class UnicodeString(Condition):
1448    arg_types = {"this": True, "escape": False}
1449
1450
1451class Column(Condition):
1452    arg_types = {"this": True, "table": False, "db": False, "catalog": False, "join_mark": False}
1453
1454    @property
1455    def table(self) -> str:
1456        return self.text("table")
1457
1458    @property
1459    def db(self) -> str:
1460        return self.text("db")
1461
1462    @property
1463    def catalog(self) -> str:
1464        return self.text("catalog")
1465
1466    @property
1467    def output_name(self) -> str:
1468        return self.name
1469
1470    @property
1471    def parts(self) -> t.List[Identifier]:
1472        """Return the parts of a column in order catalog, db, table, name."""
1473        return [
1474            t.cast(Identifier, self.args[part])
1475            for part in ("catalog", "db", "table", "this")
1476            if self.args.get(part)
1477        ]
1478
1479    def to_dot(self) -> Dot | Identifier:
1480        """Converts the column into a dot expression."""
1481        parts = self.parts
1482        parent = self.parent
1483
1484        while parent:
1485            if isinstance(parent, Dot):
1486                parts.append(parent.expression)
1487            parent = parent.parent
1488
1489        return Dot.build(deepcopy(parts)) if len(parts) > 1 else parts[0]
1490
1491
1492class ColumnPosition(Expression):
1493    arg_types = {"this": False, "position": True}
1494
1495
1496class ColumnDef(Expression):
1497    arg_types = {
1498        "this": True,
1499        "kind": False,
1500        "constraints": False,
1501        "exists": False,
1502        "position": False,
1503    }
1504
1505    @property
1506    def constraints(self) -> t.List[ColumnConstraint]:
1507        return self.args.get("constraints") or []
1508
1509    @property
1510    def kind(self) -> t.Optional[DataType]:
1511        return self.args.get("kind")
1512
1513
1514class AlterColumn(Expression):
1515    arg_types = {
1516        "this": True,
1517        "dtype": False,
1518        "collate": False,
1519        "using": False,
1520        "default": False,
1521        "drop": False,
1522        "comment": False,
1523    }
1524
1525
1526class RenameColumn(Expression):
1527    arg_types = {"this": True, "to": True, "exists": False}
1528
1529
1530class RenameTable(Expression):
1531    pass
1532
1533
1534class SwapTable(Expression):
1535    pass
1536
1537
1538class Comment(Expression):
1539    arg_types = {"this": True, "kind": True, "expression": True, "exists": False}
1540
1541
1542class Comprehension(Expression):
1543    arg_types = {"this": True, "expression": True, "iterator": True, "condition": False}
1544
1545
1546# https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#mergetree-table-ttl
1547class MergeTreeTTLAction(Expression):
1548    arg_types = {
1549        "this": True,
1550        "delete": False,
1551        "recompress": False,
1552        "to_disk": False,
1553        "to_volume": False,
1554    }
1555
1556
1557# https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#mergetree-table-ttl
1558class MergeTreeTTL(Expression):
1559    arg_types = {
1560        "expressions": True,
1561        "where": False,
1562        "group": False,
1563        "aggregates": False,
1564    }
1565
1566
1567# https://dev.mysql.com/doc/refman/8.0/en/create-table.html
1568class IndexConstraintOption(Expression):
1569    arg_types = {
1570        "key_block_size": False,
1571        "using": False,
1572        "parser": False,
1573        "comment": False,
1574        "visible": False,
1575        "engine_attr": False,
1576        "secondary_engine_attr": False,
1577    }
1578
1579
1580class ColumnConstraint(Expression):
1581    arg_types = {"this": False, "kind": True}
1582
1583    @property
1584    def kind(self) -> ColumnConstraintKind:
1585        return self.args["kind"]
1586
1587
1588class ColumnConstraintKind(Expression):
1589    pass
1590
1591
1592class AutoIncrementColumnConstraint(ColumnConstraintKind):
1593    pass
1594
1595
1596class PeriodForSystemTimeConstraint(ColumnConstraintKind):
1597    arg_types = {"this": True, "expression": True}
1598
1599
1600class CaseSpecificColumnConstraint(ColumnConstraintKind):
1601    arg_types = {"not_": True}
1602
1603
1604class CharacterSetColumnConstraint(ColumnConstraintKind):
1605    arg_types = {"this": True}
1606
1607
1608class CheckColumnConstraint(ColumnConstraintKind):
1609    arg_types = {"this": True, "enforced": False}
1610
1611
1612class ClusteredColumnConstraint(ColumnConstraintKind):
1613    pass
1614
1615
1616class CollateColumnConstraint(ColumnConstraintKind):
1617    pass
1618
1619
1620class CommentColumnConstraint(ColumnConstraintKind):
1621    pass
1622
1623
1624class CompressColumnConstraint(ColumnConstraintKind):
1625    pass
1626
1627
1628class DateFormatColumnConstraint(ColumnConstraintKind):
1629    arg_types = {"this": True}
1630
1631
1632class DefaultColumnConstraint(ColumnConstraintKind):
1633    pass
1634
1635
1636class EncodeColumnConstraint(ColumnConstraintKind):
1637    pass
1638
1639
1640# https://www.postgresql.org/docs/current/sql-createtable.html#SQL-CREATETABLE-EXCLUDE
1641class ExcludeColumnConstraint(ColumnConstraintKind):
1642    pass
1643
1644
1645class WithOperator(Expression):
1646    arg_types = {"this": True, "op": True}
1647
1648
1649class GeneratedAsIdentityColumnConstraint(ColumnConstraintKind):
1650    # this: True -> ALWAYS, this: False -> BY DEFAULT
1651    arg_types = {
1652        "this": False,
1653        "expression": False,
1654        "on_null": False,
1655        "start": False,
1656        "increment": False,
1657        "minvalue": False,
1658        "maxvalue": False,
1659        "cycle": False,
1660    }
1661
1662
1663class GeneratedAsRowColumnConstraint(ColumnConstraintKind):
1664    arg_types = {"start": False, "hidden": False}
1665
1666
1667# https://dev.mysql.com/doc/refman/8.0/en/create-table.html
1668class IndexColumnConstraint(ColumnConstraintKind):
1669    arg_types = {
1670        "this": False,
1671        "schema": True,
1672        "kind": False,
1673        "index_type": False,
1674        "options": False,
1675    }
1676
1677
1678class InlineLengthColumnConstraint(ColumnConstraintKind):
1679    pass
1680
1681
1682class NonClusteredColumnConstraint(ColumnConstraintKind):
1683    pass
1684
1685
1686class NotForReplicationColumnConstraint(ColumnConstraintKind):
1687    arg_types = {}
1688
1689
1690class NotNullColumnConstraint(ColumnConstraintKind):
1691    arg_types = {"allow_null": False}
1692
1693
1694# https://dev.mysql.com/doc/refman/5.7/en/timestamp-initialization.html
1695class OnUpdateColumnConstraint(ColumnConstraintKind):
1696    pass
1697
1698
1699# https://docs.snowflake.com/en/sql-reference/sql/create-external-table#optional-parameters
1700class TransformColumnConstraint(ColumnConstraintKind):
1701    pass
1702
1703
1704class PrimaryKeyColumnConstraint(ColumnConstraintKind):
1705    arg_types = {"desc": False}
1706
1707
1708class TitleColumnConstraint(ColumnConstraintKind):
1709    pass
1710
1711
1712class UniqueColumnConstraint(ColumnConstraintKind):
1713    arg_types = {"this": False, "index_type": False, "on_conflict": False}
1714
1715
1716class UppercaseColumnConstraint(ColumnConstraintKind):
1717    arg_types: t.Dict[str, t.Any] = {}
1718
1719
1720class PathColumnConstraint(ColumnConstraintKind):
1721    pass
1722
1723
1724# computed column expression
1725# https://learn.microsoft.com/en-us/sql/t-sql/statements/create-table-transact-sql?view=sql-server-ver16
1726class ComputedColumnConstraint(ColumnConstraintKind):
1727    arg_types = {"this": True, "persisted": False, "not_null": False}
1728
1729
1730class Constraint(Expression):
1731    arg_types = {"this": True, "expressions": True}
1732
1733
1734class Delete(DML):
1735    arg_types = {
1736        "with": False,
1737        "this": False,
1738        "using": False,
1739        "where": False,
1740        "returning": False,
1741        "limit": False,
1742        "tables": False,  # Multiple-Table Syntax (MySQL)
1743    }
1744
1745    def delete(
1746        self,
1747        table: ExpOrStr,
1748        dialect: DialectType = None,
1749        copy: bool = True,
1750        **opts,
1751    ) -> Delete:
1752        """
1753        Create a DELETE expression or replace the table on an existing DELETE expression.
1754
1755        Example:
1756            >>> delete("tbl").sql()
1757            'DELETE FROM tbl'
1758
1759        Args:
1760            table: the table from which to delete.
1761            dialect: the dialect used to parse the input expression.
1762            copy: if `False`, modify this expression instance in-place.
1763            opts: other options to use to parse the input expressions.
1764
1765        Returns:
1766            Delete: the modified expression.
1767        """
1768        return _apply_builder(
1769            expression=table,
1770            instance=self,
1771            arg="this",
1772            dialect=dialect,
1773            into=Table,
1774            copy=copy,
1775            **opts,
1776        )
1777
1778    def where(
1779        self,
1780        *expressions: t.Optional[ExpOrStr],
1781        append: bool = True,
1782        dialect: DialectType = None,
1783        copy: bool = True,
1784        **opts,
1785    ) -> Delete:
1786        """
1787        Append to or set the WHERE expressions.
1788
1789        Example:
1790            >>> delete("tbl").where("x = 'a' OR x < 'b'").sql()
1791            "DELETE FROM tbl WHERE x = 'a' OR x < 'b'"
1792
1793        Args:
1794            *expressions: the SQL code strings to parse.
1795                If an `Expression` instance is passed, it will be used as-is.
1796                Multiple expressions are combined with an AND operator.
1797            append: if `True`, AND the new expressions to any existing expression.
1798                Otherwise, this resets the expression.
1799            dialect: the dialect used to parse the input expressions.
1800            copy: if `False`, modify this expression instance in-place.
1801            opts: other options to use to parse the input expressions.
1802
1803        Returns:
1804            Delete: the modified expression.
1805        """
1806        return _apply_conjunction_builder(
1807            *expressions,
1808            instance=self,
1809            arg="where",
1810            append=append,
1811            into=Where,
1812            dialect=dialect,
1813            copy=copy,
1814            **opts,
1815        )
1816
1817
1818class Drop(Expression):
1819    arg_types = {
1820        "this": False,
1821        "kind": False,
1822        "expressions": False,
1823        "exists": False,
1824        "temporary": False,
1825        "materialized": False,
1826        "cascade": False,
1827        "constraints": False,
1828        "purge": False,
1829    }
1830
1831
1832class Filter(Expression):
1833    arg_types = {"this": True, "expression": True}
1834
1835
1836class Check(Expression):
1837    pass
1838
1839
1840# https://docs.snowflake.com/en/sql-reference/constructs/connect-by
1841class Connect(Expression):
1842    arg_types = {"start": False, "connect": True, "nocycle": False}
1843
1844
1845class Prior(Expression):
1846    pass
1847
1848
1849class Directory(Expression):
1850    # https://spark.apache.org/docs/3.0.0-preview/sql-ref-syntax-dml-insert-overwrite-directory-hive.html
1851    arg_types = {"this": True, "local": False, "row_format": False}
1852
1853
1854class ForeignKey(Expression):
1855    arg_types = {
1856        "expressions": True,
1857        "reference": False,
1858        "delete": False,
1859        "update": False,
1860    }
1861
1862
1863class ColumnPrefix(Expression):
1864    arg_types = {"this": True, "expression": True}
1865
1866
1867class PrimaryKey(Expression):
1868    arg_types = {"expressions": True, "options": False}
1869
1870
1871# https://www.postgresql.org/docs/9.1/sql-selectinto.html
1872# https://docs.aws.amazon.com/redshift/latest/dg/r_SELECT_INTO.html#r_SELECT_INTO-examples
1873class Into(Expression):
1874    arg_types = {"this": True, "temporary": False, "unlogged": False}
1875
1876
1877class From(Expression):
1878    @property
1879    def name(self) -> str:
1880        return self.this.name
1881
1882    @property
1883    def alias_or_name(self) -> str:
1884        return self.this.alias_or_name
1885
1886
1887class Having(Expression):
1888    pass
1889
1890
1891class Hint(Expression):
1892    arg_types = {"expressions": True}
1893
1894
1895class JoinHint(Expression):
1896    arg_types = {"this": True, "expressions": True}
1897
1898
1899class Identifier(Expression):
1900    arg_types = {"this": True, "quoted": False, "global": False, "temporary": False}
1901
1902    @property
1903    def quoted(self) -> bool:
1904        return bool(self.args.get("quoted"))
1905
1906    @property
1907    def hashable_args(self) -> t.Any:
1908        return (self.this, self.quoted)
1909
1910    @property
1911    def output_name(self) -> str:
1912        return self.name
1913
1914
1915# https://www.postgresql.org/docs/current/indexes-opclass.html
1916class Opclass(Expression):
1917    arg_types = {"this": True, "expression": True}
1918
1919
1920class Index(Expression):
1921    arg_types = {
1922        "this": False,
1923        "table": False,
1924        "unique": False,
1925        "primary": False,
1926        "amp": False,  # teradata
1927        "params": False,
1928    }
1929
1930
1931class IndexParameters(Expression):
1932    arg_types = {
1933        "using": False,
1934        "include": False,
1935        "columns": False,
1936        "with_storage": False,
1937        "partition_by": False,
1938        "tablespace": False,
1939        "where": False,
1940    }
1941
1942
1943class Insert(DDL, DML):
1944    arg_types = {
1945        "hint": False,
1946        "with": False,
1947        "is_function": False,
1948        "this": True,
1949        "expression": False,
1950        "conflict": False,
1951        "returning": False,
1952        "overwrite": False,
1953        "exists": False,
1954        "partition": False,
1955        "alternative": False,
1956        "where": False,
1957        "ignore": False,
1958        "by_name": False,
1959    }
1960
1961    def with_(
1962        self,
1963        alias: ExpOrStr,
1964        as_: ExpOrStr,
1965        recursive: t.Optional[bool] = None,
1966        append: bool = True,
1967        dialect: DialectType = None,
1968        copy: bool = True,
1969        **opts,
1970    ) -> Insert:
1971        """
1972        Append to or set the common table expressions.
1973
1974        Example:
1975            >>> insert("SELECT x FROM cte", "t").with_("cte", as_="SELECT * FROM tbl").sql()
1976            'WITH cte AS (SELECT * FROM tbl) INSERT INTO t SELECT x FROM cte'
1977
1978        Args:
1979            alias: the SQL code string to parse as the table name.
1980                If an `Expression` instance is passed, this is used as-is.
1981            as_: the SQL code string to parse as the table expression.
1982                If an `Expression` instance is passed, it will be used as-is.
1983            recursive: set the RECURSIVE part of the expression. Defaults to `False`.
1984            append: if `True`, add to any existing expressions.
1985                Otherwise, this resets the expressions.
1986            dialect: the dialect used to parse the input expression.
1987            copy: if `False`, modify this expression instance in-place.
1988            opts: other options to use to parse the input expressions.
1989
1990        Returns:
1991            The modified expression.
1992        """
1993        return _apply_cte_builder(
1994            self, alias, as_, recursive=recursive, append=append, dialect=dialect, copy=copy, **opts
1995        )
1996
1997
1998class OnConflict(Expression):
1999    arg_types = {
2000        "duplicate": False,
2001        "expressions": False,
2002        "action": False,
2003        "conflict_keys": False,
2004        "constraint": False,
2005    }
2006
2007
2008class Returning(Expression):
2009    arg_types = {"expressions": True, "into": False}
2010
2011
2012# https://dev.mysql.com/doc/refman/8.0/en/charset-introducer.html
2013class Introducer(Expression):
2014    arg_types = {"this": True, "expression": True}
2015
2016
2017# national char, like n'utf8'
2018class National(Expression):
2019    pass
2020
2021
2022class LoadData(Expression):
2023    arg_types = {
2024        "this": True,
2025        "local": False,
2026        "overwrite": False,
2027        "inpath": True,
2028        "partition": False,
2029        "input_format": False,
2030        "serde": False,
2031    }
2032
2033
2034class Partition(Expression):
2035    arg_types = {"expressions": True}
2036
2037
2038class PartitionRange(Expression):
2039    arg_types = {"this": True, "expression": True}
2040
2041
2042class Fetch(Expression):
2043    arg_types = {
2044        "direction": False,
2045        "count": False,
2046        "percent": False,
2047        "with_ties": False,
2048    }
2049
2050
2051class Group(Expression):
2052    arg_types = {
2053        "expressions": False,
2054        "grouping_sets": False,
2055        "cube": False,
2056        "rollup": False,
2057        "totals": False,
2058        "all": False,
2059    }
2060
2061
2062class Lambda(Expression):
2063    arg_types = {"this": True, "expressions": True}
2064
2065
2066class Limit(Expression):
2067    arg_types = {"this": False, "expression": True, "offset": False, "expressions": False}
2068
2069
2070class Literal(Condition):
2071    arg_types = {"this": True, "is_string": True}
2072
2073    @property
2074    def hashable_args(self) -> t.Any:
2075        return (self.this, self.args.get("is_string"))
2076
2077    @classmethod
2078    def number(cls, number) -> Literal:
2079        return cls(this=str(number), is_string=False)
2080
2081    @classmethod
2082    def string(cls, string) -> Literal:
2083        return cls(this=str(string), is_string=True)
2084
2085    @property
2086    def output_name(self) -> str:
2087        return self.name
2088
2089
2090class Join(Expression):
2091    arg_types = {
2092        "this": True,
2093        "on": False,
2094        "side": False,
2095        "kind": False,
2096        "using": False,
2097        "method": False,
2098        "global": False,
2099        "hint": False,
2100    }
2101
2102    @property
2103    def method(self) -> str:
2104        return self.text("method").upper()
2105
2106    @property
2107    def kind(self) -> str:
2108        return self.text("kind").upper()
2109
2110    @property
2111    def side(self) -> str:
2112        return self.text("side").upper()
2113
2114    @property
2115    def hint(self) -> str:
2116        return self.text("hint").upper()
2117
2118    @property
2119    def alias_or_name(self) -> str:
2120        return self.this.alias_or_name
2121
2122    def on(
2123        self,
2124        *expressions: t.Optional[ExpOrStr],
2125        append: bool = True,
2126        dialect: DialectType = None,
2127        copy: bool = True,
2128        **opts,
2129    ) -> Join:
2130        """
2131        Append to or set the ON expressions.
2132
2133        Example:
2134            >>> import sqlglot
2135            >>> sqlglot.parse_one("JOIN x", into=Join).on("y = 1").sql()
2136            'JOIN x ON y = 1'
2137
2138        Args:
2139            *expressions: the SQL code strings to parse.
2140                If an `Expression` instance is passed, it will be used as-is.
2141                Multiple expressions are combined with an AND operator.
2142            append: if `True`, AND the new expressions to any existing expression.
2143                Otherwise, this resets the expression.
2144            dialect: the dialect used to parse the input expressions.
2145            copy: if `False`, modify this expression instance in-place.
2146            opts: other options to use to parse the input expressions.
2147
2148        Returns:
2149            The modified Join expression.
2150        """
2151        join = _apply_conjunction_builder(
2152            *expressions,
2153            instance=self,
2154            arg="on",
2155            append=append,
2156            dialect=dialect,
2157            copy=copy,
2158            **opts,
2159        )
2160
2161        if join.kind == "CROSS":
2162            join.set("kind", None)
2163
2164        return join
2165
2166    def using(
2167        self,
2168        *expressions: t.Optional[ExpOrStr],
2169        append: bool = True,
2170        dialect: DialectType = None,
2171        copy: bool = True,
2172        **opts,
2173    ) -> Join:
2174        """
2175        Append to or set the USING expressions.
2176
2177        Example:
2178            >>> import sqlglot
2179            >>> sqlglot.parse_one("JOIN x", into=Join).using("foo", "bla").sql()
2180            'JOIN x USING (foo, bla)'
2181
2182        Args:
2183            *expressions: the SQL code strings to parse.
2184                If an `Expression` instance is passed, it will be used as-is.
2185            append: if `True`, concatenate the new expressions to the existing "using" list.
2186                Otherwise, this resets the expression.
2187            dialect: the dialect used to parse the input expressions.
2188            copy: if `False`, modify this expression instance in-place.
2189            opts: other options to use to parse the input expressions.
2190
2191        Returns:
2192            The modified Join expression.
2193        """
2194        join = _apply_list_builder(
2195            *expressions,
2196            instance=self,
2197            arg="using",
2198            append=append,
2199            dialect=dialect,
2200            copy=copy,
2201            **opts,
2202        )
2203
2204        if join.kind == "CROSS":
2205            join.set("kind", None)
2206
2207        return join
2208
2209
2210class Lateral(UDTF):
2211    arg_types = {
2212        "this": True,
2213        "view": False,
2214        "outer": False,
2215        "alias": False,
2216        "cross_apply": False,  # True -> CROSS APPLY, False -> OUTER APPLY
2217    }
2218
2219
2220class MatchRecognize(Expression):
2221    arg_types = {
2222        "partition_by": False,
2223        "order": False,
2224        "measures": False,
2225        "rows": False,
2226        "after": False,
2227        "pattern": False,
2228        "define": False,
2229        "alias": False,
2230    }
2231
2232
2233# Clickhouse FROM FINAL modifier
2234# https://clickhouse.com/docs/en/sql-reference/statements/select/from/#final-modifier
2235class Final(Expression):
2236    pass
2237
2238
2239class Offset(Expression):
2240    arg_types = {"this": False, "expression": True, "expressions": False}
2241
2242
2243class Order(Expression):
2244    arg_types = {
2245        "this": False,
2246        "expressions": True,
2247        "interpolate": False,
2248        "siblings": False,
2249    }
2250
2251
2252# https://clickhouse.com/docs/en/sql-reference/statements/select/order-by#order-by-expr-with-fill-modifier
2253class WithFill(Expression):
2254    arg_types = {"from": False, "to": False, "step": False}
2255
2256
2257# hive specific sorts
2258# https://cwiki.apache.org/confluence/display/Hive/LanguageManual+SortBy
2259class Cluster(Order):
2260    pass
2261
2262
2263class Distribute(Order):
2264    pass
2265
2266
2267class Sort(Order):
2268    pass
2269
2270
2271class Ordered(Expression):
2272    arg_types = {"this": True, "desc": False, "nulls_first": True, "with_fill": False}
2273
2274
2275class Property(Expression):
2276    arg_types = {"this": True, "value": True}
2277
2278
2279class AlgorithmProperty(Property):
2280    arg_types = {"this": True}
2281
2282
2283class AutoIncrementProperty(Property):
2284    arg_types = {"this": True}
2285
2286
2287# https://docs.aws.amazon.com/prescriptive-guidance/latest/materialized-views-redshift/refreshing-materialized-views.html
2288class AutoRefreshProperty(Property):
2289    arg_types = {"this": True}
2290
2291
2292class BackupProperty(Property):
2293    arg_types = {"this": True}
2294
2295
2296class BlockCompressionProperty(Property):
2297    arg_types = {
2298        "autotemp": False,
2299        "always": False,
2300        "default": False,
2301        "manual": False,
2302        "never": False,
2303    }
2304
2305
2306class CharacterSetProperty(Property):
2307    arg_types = {"this": True, "default": True}
2308
2309
2310class ChecksumProperty(Property):
2311    arg_types = {"on": False, "default": False}
2312
2313
2314class CollateProperty(Property):
2315    arg_types = {"this": True, "default": False}
2316
2317
2318class CopyGrantsProperty(Property):
2319    arg_types = {}
2320
2321
2322class DataBlocksizeProperty(Property):
2323    arg_types = {
2324        "size": False,
2325        "units": False,
2326        "minimum": False,
2327        "maximum": False,
2328        "default": False,
2329    }
2330
2331
2332class DefinerProperty(Property):
2333    arg_types = {"this": True}
2334
2335
2336class DistKeyProperty(Property):
2337    arg_types = {"this": True}
2338
2339
2340class DistStyleProperty(Property):
2341    arg_types = {"this": True}
2342
2343
2344class EngineProperty(Property):
2345    arg_types = {"this": True}
2346
2347
2348class HeapProperty(Property):
2349    arg_types = {}
2350
2351
2352class ToTableProperty(Property):
2353    arg_types = {"this": True}
2354
2355
2356class ExecuteAsProperty(Property):
2357    arg_types = {"this": True}
2358
2359
2360class ExternalProperty(Property):
2361    arg_types = {"this": False}
2362
2363
2364class FallbackProperty(Property):
2365    arg_types = {"no": True, "protection": False}
2366
2367
2368class FileFormatProperty(Property):
2369    arg_types = {"this": True}
2370
2371
2372class FreespaceProperty(Property):
2373    arg_types = {"this": True, "percent": False}
2374
2375
2376class GlobalProperty(Property):
2377    arg_types = {}
2378
2379
2380class IcebergProperty(Property):
2381    arg_types = {}
2382
2383
2384class InheritsProperty(Property):
2385    arg_types = {"expressions": True}
2386
2387
2388class InputModelProperty(Property):
2389    arg_types = {"this": True}
2390
2391
2392class OutputModelProperty(Property):
2393    arg_types = {"this": True}
2394
2395
2396class IsolatedLoadingProperty(Property):
2397    arg_types = {"no": False, "concurrent": False, "target": False}
2398
2399
2400class JournalProperty(Property):
2401    arg_types = {
2402        "no": False,
2403        "dual": False,
2404        "before": False,
2405        "local": False,
2406        "after": False,
2407    }
2408
2409
2410class LanguageProperty(Property):
2411    arg_types = {"this": True}
2412
2413
2414# spark ddl
2415class ClusteredByProperty(Property):
2416    arg_types = {"expressions": True, "sorted_by": False, "buckets": True}
2417
2418
2419class DictProperty(Property):
2420    arg_types = {"this": True, "kind": True, "settings": False}
2421
2422
2423class DictSubProperty(Property):
2424    pass
2425
2426
2427class DictRange(Property):
2428    arg_types = {"this": True, "min": True, "max": True}
2429
2430
2431# Clickhouse CREATE ... ON CLUSTER modifier
2432# https://clickhouse.com/docs/en/sql-reference/distributed-ddl
2433class OnCluster(Property):
2434    arg_types = {"this": True}
2435
2436
2437class LikeProperty(Property):
2438    arg_types = {"this": True, "expressions": False}
2439
2440
2441class LocationProperty(Property):
2442    arg_types = {"this": True}
2443
2444
2445class LockProperty(Property):
2446    arg_types = {"this": True}
2447
2448
2449class LockingProperty(Property):
2450    arg_types = {
2451        "this": False,
2452        "kind": True,
2453        "for_or_in": False,
2454        "lock_type": True,
2455        "override": False,
2456    }
2457
2458
2459class LogProperty(Property):
2460    arg_types = {"no": True}
2461
2462
2463class MaterializedProperty(Property):
2464    arg_types = {"this": False}
2465
2466
2467class MergeBlockRatioProperty(Property):
2468    arg_types = {"this": False, "no": False, "default": False, "percent": False}
2469
2470
2471class NoPrimaryIndexProperty(Property):
2472    arg_types = {}
2473
2474
2475class OnProperty(Property):
2476    arg_types = {"this": True}
2477
2478
2479class OnCommitProperty(Property):
2480    arg_types = {"delete": False}
2481
2482
2483class PartitionedByProperty(Property):
2484    arg_types = {"this": True}
2485
2486
2487# https://www.postgresql.org/docs/current/sql-createtable.html
2488class PartitionBoundSpec(Expression):
2489    # this -> IN / MODULUS, expression -> REMAINDER, from_expressions -> FROM (...), to_expressions -> TO (...)
2490    arg_types = {
2491        "this": False,
2492        "expression": False,
2493        "from_expressions": False,
2494        "to_expressions": False,
2495    }
2496
2497
2498class PartitionedOfProperty(Property):
2499    # this -> parent_table (schema), expression -> FOR VALUES ... / DEFAULT
2500    arg_types = {"this": True, "expression": True}
2501
2502
2503class RemoteWithConnectionModelProperty(Property):
2504    arg_types = {"this": True}
2505
2506
2507class ReturnsProperty(Property):
2508    arg_types = {"this": True, "is_table": False, "table": False}
2509
2510
2511class RowFormatProperty(Property):
2512    arg_types = {"this": True}
2513
2514
2515class RowFormatDelimitedProperty(Property):
2516    # https://cwiki.apache.org/confluence/display/hive/languagemanual+dml
2517    arg_types = {
2518        "fields": False,
2519        "escaped": False,
2520        "collection_items": False,
2521        "map_keys": False,
2522        "lines": False,
2523        "null": False,
2524        "serde": False,
2525    }
2526
2527
2528class RowFormatSerdeProperty(Property):
2529    arg_types = {"this": True, "serde_properties": False}
2530
2531
2532# https://spark.apache.org/docs/3.1.2/sql-ref-syntax-qry-select-transform.html
2533class QueryTransform(Expression):
2534    arg_types = {
2535        "expressions": True,
2536        "command_script": True,
2537        "schema": False,
2538        "row_format_before": False,
2539        "record_writer": False,
2540        "row_format_after": False,
2541        "record_reader": False,
2542    }
2543
2544
2545class SampleProperty(Property):
2546    arg_types = {"this": True}
2547
2548
2549class SchemaCommentProperty(Property):
2550    arg_types = {"this": True}
2551
2552
2553class SerdeProperties(Property):
2554    arg_types = {"expressions": True}
2555
2556
2557class SetProperty(Property):
2558    arg_types = {"multi": True}
2559
2560
2561class SharingProperty(Property):
2562    arg_types = {"this": False}
2563
2564
2565class SetConfigProperty(Property):
2566    arg_types = {"this": True}
2567
2568
2569class SettingsProperty(Property):
2570    arg_types = {"expressions": True}
2571
2572
2573class SortKeyProperty(Property):
2574    arg_types = {"this": True, "compound": False}
2575
2576
2577class SqlReadWriteProperty(Property):
2578    arg_types = {"this": True}
2579
2580
2581class SqlSecurityProperty(Property):
2582    arg_types = {"definer": True}
2583
2584
2585class StabilityProperty(Property):
2586    arg_types = {"this": True}
2587
2588
2589class TemporaryProperty(Property):
2590    arg_types = {"this": False}
2591
2592
2593class TransformModelProperty(Property):
2594    arg_types = {"expressions": True}
2595
2596
2597class TransientProperty(Property):
2598    arg_types = {"this": False}
2599
2600
2601class UnloggedProperty(Property):
2602    arg_types = {}
2603
2604
2605# https://learn.microsoft.com/en-us/sql/t-sql/statements/create-view-transact-sql?view=sql-server-ver16
2606class ViewAttributeProperty(Property):
2607    arg_types = {"this": True}
2608
2609
2610class VolatileProperty(Property):
2611    arg_types = {"this": False}
2612
2613
2614class WithDataProperty(Property):
2615    arg_types = {"no": True, "statistics": False}
2616
2617
2618class WithJournalTableProperty(Property):
2619    arg_types = {"this": True}
2620
2621
2622class WithSystemVersioningProperty(Property):
2623    # this -> history table name, expression -> data consistency check
2624    arg_types = {"this": False, "expression": False}
2625
2626
2627class Properties(Expression):
2628    arg_types = {"expressions": True}
2629
2630    NAME_TO_PROPERTY = {
2631        "ALGORITHM": AlgorithmProperty,
2632        "AUTO_INCREMENT": AutoIncrementProperty,
2633        "CHARACTER SET": CharacterSetProperty,
2634        "CLUSTERED_BY": ClusteredByProperty,
2635        "COLLATE": CollateProperty,
2636        "COMMENT": SchemaCommentProperty,
2637        "DEFINER": DefinerProperty,
2638        "DISTKEY": DistKeyProperty,
2639        "DISTSTYLE": DistStyleProperty,
2640        "ENGINE": EngineProperty,
2641        "EXECUTE AS": ExecuteAsProperty,
2642        "FORMAT": FileFormatProperty,
2643        "LANGUAGE": LanguageProperty,
2644        "LOCATION": LocationProperty,
2645        "LOCK": LockProperty,
2646        "PARTITIONED_BY": PartitionedByProperty,
2647        "RETURNS": ReturnsProperty,
2648        "ROW_FORMAT": RowFormatProperty,
2649        "SORTKEY": SortKeyProperty,
2650    }
2651
2652    PROPERTY_TO_NAME = {v: k for k, v in NAME_TO_PROPERTY.items()}
2653
2654    # CREATE property locations
2655    # Form: schema specified
2656    #   create [POST_CREATE]
2657    #     table a [POST_NAME]
2658    #     (b int) [POST_SCHEMA]
2659    #     with ([POST_WITH])
2660    #     index (b) [POST_INDEX]
2661    #
2662    # Form: alias selection
2663    #   create [POST_CREATE]
2664    #     table a [POST_NAME]
2665    #     as [POST_ALIAS] (select * from b) [POST_EXPRESSION]
2666    #     index (c) [POST_INDEX]
2667    class Location(AutoName):
2668        POST_CREATE = auto()
2669        POST_NAME = auto()
2670        POST_SCHEMA = auto()
2671        POST_WITH = auto()
2672        POST_ALIAS = auto()
2673        POST_EXPRESSION = auto()
2674        POST_INDEX = auto()
2675        UNSUPPORTED = auto()
2676
2677    @classmethod
2678    def from_dict(cls, properties_dict: t.Dict) -> Properties:
2679        expressions = []
2680        for key, value in properties_dict.items():
2681            property_cls = cls.NAME_TO_PROPERTY.get(key.upper())
2682            if property_cls:
2683                expressions.append(property_cls(this=convert(value)))
2684            else:
2685                expressions.append(Property(this=Literal.string(key), value=convert(value)))
2686
2687        return cls(expressions=expressions)
2688
2689
2690class Qualify(Expression):
2691    pass
2692
2693
2694class InputOutputFormat(Expression):
2695    arg_types = {"input_format": False, "output_format": False}
2696
2697
2698# https://www.ibm.com/docs/en/ias?topic=procedures-return-statement-in-sql
2699class Return(Expression):
2700    pass
2701
2702
2703class Reference(Expression):
2704    arg_types = {"this": True, "expressions": False, "options": False}
2705
2706
2707class Tuple(Expression):
2708    arg_types = {"expressions": False}
2709
2710    def isin(
2711        self,
2712        *expressions: t.Any,
2713        query: t.Optional[ExpOrStr] = None,
2714        unnest: t.Optional[ExpOrStr] | t.Collection[ExpOrStr] = None,
2715        copy: bool = True,
2716        **opts,
2717    ) -> In:
2718        return In(
2719            this=maybe_copy(self, copy),
2720            expressions=[convert(e, copy=copy) for e in expressions],
2721            query=maybe_parse(query, copy=copy, **opts) if query else None,
2722            unnest=(
2723                Unnest(
2724                    expressions=[
2725                        maybe_parse(t.cast(ExpOrStr, e), copy=copy, **opts)
2726                        for e in ensure_list(unnest)
2727                    ]
2728                )
2729                if unnest
2730                else None
2731            ),
2732        )
2733
2734
2735QUERY_MODIFIERS = {
2736    "match": False,
2737    "laterals": False,
2738    "joins": False,
2739    "connect": False,
2740    "pivots": False,
2741    "prewhere": False,
2742    "where": False,
2743    "group": False,
2744    "having": False,
2745    "qualify": False,
2746    "windows": False,
2747    "distribute": False,
2748    "sort": False,
2749    "cluster": False,
2750    "order": False,
2751    "limit": False,
2752    "offset": False,
2753    "locks": False,
2754    "sample": False,
2755    "settings": False,
2756    "format": False,
2757    "options": False,
2758}
2759
2760
2761# https://learn.microsoft.com/en-us/sql/t-sql/queries/option-clause-transact-sql?view=sql-server-ver16
2762# https://learn.microsoft.com/en-us/sql/t-sql/queries/hints-transact-sql-query?view=sql-server-ver16
2763class QueryOption(Expression):
2764    arg_types = {"this": True, "expression": False}
2765
2766
2767# https://learn.microsoft.com/en-us/sql/t-sql/queries/hints-transact-sql-table?view=sql-server-ver16
2768class WithTableHint(Expression):
2769    arg_types = {"expressions": True}
2770
2771
2772# https://dev.mysql.com/doc/refman/8.0/en/index-hints.html
2773class IndexTableHint(Expression):
2774    arg_types = {"this": True, "expressions": False, "target": False}
2775
2776
2777# https://docs.snowflake.com/en/sql-reference/constructs/at-before
2778class HistoricalData(Expression):
2779    arg_types = {"this": True, "kind": True, "expression": True}
2780
2781
2782class Table(Expression):
2783    arg_types = {
2784        "this": False,
2785        "alias": False,
2786        "db": False,
2787        "catalog": False,
2788        "laterals": False,
2789        "joins": False,
2790        "pivots": False,
2791        "hints": False,
2792        "system_time": False,
2793        "version": False,
2794        "format": False,
2795        "pattern": False,
2796        "ordinality": False,
2797        "when": False,
2798        "only": False,
2799    }
2800
2801    @property
2802    def name(self) -> str:
2803        if isinstance(self.this, Func):
2804            return ""
2805        return self.this.name
2806
2807    @property
2808    def db(self) -> str:
2809        return self.text("db")
2810
2811    @property
2812    def catalog(self) -> str:
2813        return self.text("catalog")
2814
2815    @property
2816    def selects(self) -> t.List[Expression]:
2817        return []
2818
2819    @property
2820    def named_selects(self) -> t.List[str]:
2821        return []
2822
2823    @property
2824    def parts(self) -> t.List[Expression]:
2825        """Return the parts of a table in order catalog, db, table."""
2826        parts: t.List[Expression] = []
2827
2828        for arg in ("catalog", "db", "this"):
2829            part = self.args.get(arg)
2830
2831            if isinstance(part, Dot):
2832                parts.extend(part.flatten())
2833            elif isinstance(part, Expression):
2834                parts.append(part)
2835
2836        return parts
2837
2838    def to_column(self, copy: bool = True) -> Alias | Column | Dot:
2839        parts = self.parts
2840        col = column(*reversed(parts[0:4]), fields=parts[4:], copy=copy)  # type: ignore
2841        alias = self.args.get("alias")
2842        if alias:
2843            col = alias_(col, alias.this, copy=copy)
2844        return col
2845
2846
2847class Union(Query):
2848    arg_types = {
2849        "with": False,
2850        "this": True,
2851        "expression": True,
2852        "distinct": False,
2853        "by_name": False,
2854        **QUERY_MODIFIERS,
2855    }
2856
2857    def select(
2858        self,
2859        *expressions: t.Optional[ExpOrStr],
2860        append: bool = True,
2861        dialect: DialectType = None,
2862        copy: bool = True,
2863        **opts,
2864    ) -> Union:
2865        this = maybe_copy(self, copy)
2866        this.this.unnest().select(*expressions, append=append, dialect=dialect, copy=False, **opts)
2867        this.expression.unnest().select(
2868            *expressions, append=append, dialect=dialect, copy=False, **opts
2869        )
2870        return this
2871
2872    @property
2873    def named_selects(self) -> t.List[str]:
2874        return self.this.unnest().named_selects
2875
2876    @property
2877    def is_star(self) -> bool:
2878        return self.this.is_star or self.expression.is_star
2879
2880    @property
2881    def selects(self) -> t.List[Expression]:
2882        return self.this.unnest().selects
2883
2884    @property
2885    def left(self) -> Expression:
2886        return self.this
2887
2888    @property
2889    def right(self) -> Expression:
2890        return self.expression
2891
2892
2893class Except(Union):
2894    pass
2895
2896
2897class Intersect(Union):
2898    pass
2899
2900
2901class Unnest(UDTF):
2902    arg_types = {
2903        "expressions": True,
2904        "alias": False,
2905        "offset": False,
2906    }
2907
2908    @property
2909    def selects(self) -> t.List[Expression]:
2910        columns = super().selects
2911        offset = self.args.get("offset")
2912        if offset:
2913            columns = columns + [to_identifier("offset") if offset is True else offset]
2914        return columns
2915
2916
2917class Update(Expression):
2918    arg_types = {
2919        "with": False,
2920        "this": False,
2921        "expressions": True,
2922        "from": False,
2923        "where": False,
2924        "returning": False,
2925        "order": False,
2926        "limit": False,
2927    }
2928
2929
2930class Values(UDTF):
2931    arg_types = {"expressions": True, "alias": False}
2932
2933
2934class Var(Expression):
2935    pass
2936
2937
2938class Version(Expression):
2939    """
2940    Time travel, iceberg, bigquery etc
2941    https://trino.io/docs/current/connector/iceberg.html?highlight=snapshot#using-snapshots
2942    https://www.databricks.com/blog/2019/02/04/introducing-delta-time-travel-for-large-scale-data-lakes.html
2943    https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#for_system_time_as_of
2944    https://learn.microsoft.com/en-us/sql/relational-databases/tables/querying-data-in-a-system-versioned-temporal-table?view=sql-server-ver16
2945    this is either TIMESTAMP or VERSION
2946    kind is ("AS OF", "BETWEEN")
2947    """
2948
2949    arg_types = {"this": True, "kind": True, "expression": False}
2950
2951
2952class Schema(Expression):
2953    arg_types = {"this": False, "expressions": False}
2954
2955
2956# https://dev.mysql.com/doc/refman/8.0/en/select.html
2957# https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/SELECT.html
2958class Lock(Expression):
2959    arg_types = {"update": True, "expressions": False, "wait": False}
2960
2961
2962class Select(Query):
2963    arg_types = {
2964        "with": False,
2965        "kind": False,
2966        "expressions": False,
2967        "hint": False,
2968        "distinct": False,
2969        "into": False,
2970        "from": False,
2971        **QUERY_MODIFIERS,
2972    }
2973
2974    def from_(
2975        self, expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts
2976    ) -> Select:
2977        """
2978        Set the FROM expression.
2979
2980        Example:
2981            >>> Select().from_("tbl").select("x").sql()
2982            'SELECT x FROM tbl'
2983
2984        Args:
2985            expression : the SQL code strings to parse.
2986                If a `From` instance is passed, this is used as-is.
2987                If another `Expression` instance is passed, it will be wrapped in a `From`.
2988            dialect: the dialect used to parse the input expression.
2989            copy: if `False`, modify this expression instance in-place.
2990            opts: other options to use to parse the input expressions.
2991
2992        Returns:
2993            The modified Select expression.
2994        """
2995        return _apply_builder(
2996            expression=expression,
2997            instance=self,
2998            arg="from",
2999            into=From,
3000            prefix="FROM",
3001            dialect=dialect,
3002            copy=copy,
3003            **opts,
3004        )
3005
3006    def group_by(
3007        self,
3008        *expressions: t.Optional[ExpOrStr],
3009        append: bool = True,
3010        dialect: DialectType = None,
3011        copy: bool = True,
3012        **opts,
3013    ) -> Select:
3014        """
3015        Set the GROUP BY expression.
3016
3017        Example:
3018            >>> Select().from_("tbl").select("x", "COUNT(1)").group_by("x").sql()
3019            'SELECT x, COUNT(1) FROM tbl GROUP BY x'
3020
3021        Args:
3022            *expressions: the SQL code strings to parse.
3023                If a `Group` instance is passed, this is used as-is.
3024                If another `Expression` instance is passed, it will be wrapped in a `Group`.
3025                If nothing is passed in then a group by is not applied to the expression
3026            append: if `True`, add to any existing expressions.
3027                Otherwise, this flattens all the `Group` expression into a single expression.
3028            dialect: the dialect used to parse the input expression.
3029            copy: if `False`, modify this expression instance in-place.
3030            opts: other options to use to parse the input expressions.
3031
3032        Returns:
3033            The modified Select expression.
3034        """
3035        if not expressions:
3036            return self if not copy else self.copy()
3037
3038        return _apply_child_list_builder(
3039            *expressions,
3040            instance=self,
3041            arg="group",
3042            append=append,
3043            copy=copy,
3044            prefix="GROUP BY",
3045            into=Group,
3046            dialect=dialect,
3047            **opts,
3048        )
3049
3050    def order_by(
3051        self,
3052        *expressions: t.Optional[ExpOrStr],
3053        append: bool = True,
3054        dialect: DialectType = None,
3055        copy: bool = True,
3056        **opts,
3057    ) -> Select:
3058        """
3059        Set the ORDER BY expression.
3060
3061        Example:
3062            >>> Select().from_("tbl").select("x").order_by("x DESC").sql()
3063            'SELECT x FROM tbl ORDER BY x DESC'
3064
3065        Args:
3066            *expressions: the SQL code strings to parse.
3067                If a `Group` instance is passed, this is used as-is.
3068                If another `Expression` instance is passed, it will be wrapped in a `Order`.
3069            append: if `True`, add to any existing expressions.
3070                Otherwise, this flattens all the `Order` expression into a single expression.
3071            dialect: the dialect used to parse the input expression.
3072            copy: if `False`, modify this expression instance in-place.
3073            opts: other options to use to parse the input expressions.
3074
3075        Returns:
3076            The modified Select expression.
3077        """
3078        return _apply_child_list_builder(
3079            *expressions,
3080            instance=self,
3081            arg="order",
3082            append=append,
3083            copy=copy,
3084            prefix="ORDER BY",
3085            into=Order,
3086            dialect=dialect,
3087            **opts,
3088        )
3089
3090    def sort_by(
3091        self,
3092        *expressions: t.Optional[ExpOrStr],
3093        append: bool = True,
3094        dialect: DialectType = None,
3095        copy: bool = True,
3096        **opts,
3097    ) -> Select:
3098        """
3099        Set the SORT BY expression.
3100
3101        Example:
3102            >>> Select().from_("tbl").select("x").sort_by("x DESC").sql(dialect="hive")
3103            'SELECT x FROM tbl SORT BY x DESC'
3104
3105        Args:
3106            *expressions: the SQL code strings to parse.
3107                If a `Group` instance is passed, this is used as-is.
3108                If another `Expression` instance is passed, it will be wrapped in a `SORT`.
3109            append: if `True`, add to any existing expressions.
3110                Otherwise, this flattens all the `Order` expression into a single expression.
3111            dialect: the dialect used to parse the input expression.
3112            copy: if `False`, modify this expression instance in-place.
3113            opts: other options to use to parse the input expressions.
3114
3115        Returns:
3116            The modified Select expression.
3117        """
3118        return _apply_child_list_builder(
3119            *expressions,
3120            instance=self,
3121            arg="sort",
3122            append=append,
3123            copy=copy,
3124            prefix="SORT BY",
3125            into=Sort,
3126            dialect=dialect,
3127            **opts,
3128        )
3129
3130    def cluster_by(
3131        self,
3132        *expressions: t.Optional[ExpOrStr],
3133        append: bool = True,
3134        dialect: DialectType = None,
3135        copy: bool = True,
3136        **opts,
3137    ) -> Select:
3138        """
3139        Set the CLUSTER BY expression.
3140
3141        Example:
3142            >>> Select().from_("tbl").select("x").cluster_by("x DESC").sql(dialect="hive")
3143            'SELECT x FROM tbl CLUSTER BY x DESC'
3144
3145        Args:
3146            *expressions: the SQL code strings to parse.
3147                If a `Group` instance is passed, this is used as-is.
3148                If another `Expression` instance is passed, it will be wrapped in a `Cluster`.
3149            append: if `True`, add to any existing expressions.
3150                Otherwise, this flattens all the `Order` expression into a single expression.
3151            dialect: the dialect used to parse the input expression.
3152            copy: if `False`, modify this expression instance in-place.
3153            opts: other options to use to parse the input expressions.
3154
3155        Returns:
3156            The modified Select expression.
3157        """
3158        return _apply_child_list_builder(
3159            *expressions,
3160            instance=self,
3161            arg="cluster",
3162            append=append,
3163            copy=copy,
3164            prefix="CLUSTER BY",
3165            into=Cluster,
3166            dialect=dialect,
3167            **opts,
3168        )
3169
3170    def limit(
3171        self, expression: ExpOrStr | int, dialect: DialectType = None, copy: bool = True, **opts
3172    ) -> Select:
3173        return _apply_builder(
3174            expression=expression,
3175            instance=self,
3176            arg="limit",
3177            into=Limit,
3178            prefix="LIMIT",
3179            dialect=dialect,
3180            copy=copy,
3181            into_arg="expression",
3182            **opts,
3183        )
3184
3185    def offset(
3186        self, expression: ExpOrStr | int, dialect: DialectType = None, copy: bool = True, **opts
3187    ) -> Select:
3188        """
3189        Set the OFFSET expression.
3190
3191        Example:
3192            >>> Select().from_("tbl").select("x").offset(10).sql()
3193            'SELECT x FROM tbl OFFSET 10'
3194
3195        Args:
3196            expression: the SQL code string to parse.
3197                This can also be an integer.
3198                If a `Offset` instance is passed, this is used as-is.
3199                If another `Expression` instance is passed, it will be wrapped in a `Offset`.
3200            dialect: the dialect used to parse the input expression.
3201            copy: if `False`, modify this expression instance in-place.
3202            opts: other options to use to parse the input expressions.
3203
3204        Returns:
3205            The modified Select expression.
3206        """
3207        return _apply_builder(
3208            expression=expression,
3209            instance=self,
3210            arg="offset",
3211            into=Offset,
3212            prefix="OFFSET",
3213            dialect=dialect,
3214            copy=copy,
3215            into_arg="expression",
3216            **opts,
3217        )
3218
3219    def select(
3220        self,
3221        *expressions: t.Optional[ExpOrStr],
3222        append: bool = True,
3223        dialect: DialectType = None,
3224        copy: bool = True,
3225        **opts,
3226    ) -> Select:
3227        return _apply_list_builder(
3228            *expressions,
3229            instance=self,
3230            arg="expressions",
3231            append=append,
3232            dialect=dialect,
3233            into=Expression,
3234            copy=copy,
3235            **opts,
3236        )
3237
3238    def lateral(
3239        self,
3240        *expressions: t.Optional[ExpOrStr],
3241        append: bool = True,
3242        dialect: DialectType = None,
3243        copy: bool = True,
3244        **opts,
3245    ) -> Select:
3246        """
3247        Append to or set the LATERAL expressions.
3248
3249        Example:
3250            >>> Select().select("x").lateral("OUTER explode(y) tbl2 AS z").from_("tbl").sql()
3251            'SELECT x FROM tbl LATERAL VIEW OUTER EXPLODE(y) tbl2 AS z'
3252
3253        Args:
3254            *expressions: the SQL code strings to parse.
3255                If an `Expression` instance is passed, it will be used as-is.
3256            append: if `True`, add to any existing expressions.
3257                Otherwise, this resets the expressions.
3258            dialect: the dialect used to parse the input expressions.
3259            copy: if `False`, modify this expression instance in-place.
3260            opts: other options to use to parse the input expressions.
3261
3262        Returns:
3263            The modified Select expression.
3264        """
3265        return _apply_list_builder(
3266            *expressions,
3267            instance=self,
3268            arg="laterals",
3269            append=append,
3270            into=Lateral,
3271            prefix="LATERAL VIEW",
3272            dialect=dialect,
3273            copy=copy,
3274            **opts,
3275        )
3276
3277    def join(
3278        self,
3279        expression: ExpOrStr,
3280        on: t.Optional[ExpOrStr] = None,
3281        using: t.Optional[ExpOrStr | t.Collection[ExpOrStr]] = None,
3282        append: bool = True,
3283        join_type: t.Optional[str] = None,
3284        join_alias: t.Optional[Identifier | str] = None,
3285        dialect: DialectType = None,
3286        copy: bool = True,
3287        **opts,
3288    ) -> Select:
3289        """
3290        Append to or set the JOIN expressions.
3291
3292        Example:
3293            >>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y").sql()
3294            'SELECT * FROM tbl JOIN tbl2 ON tbl1.y = tbl2.y'
3295
3296            >>> Select().select("1").from_("a").join("b", using=["x", "y", "z"]).sql()
3297            'SELECT 1 FROM a JOIN b USING (x, y, z)'
3298
3299            Use `join_type` to change the type of join:
3300
3301            >>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y", join_type="left outer").sql()
3302            'SELECT * FROM tbl LEFT OUTER JOIN tbl2 ON tbl1.y = tbl2.y'
3303
3304        Args:
3305            expression: the SQL code string to parse.
3306                If an `Expression` instance is passed, it will be used as-is.
3307            on: optionally specify the join "on" criteria as a SQL string.
3308                If an `Expression` instance is passed, it will be used as-is.
3309            using: optionally specify the join "using" criteria as a SQL string.
3310                If an `Expression` instance is passed, it will be used as-is.
3311            append: if `True`, add to any existing expressions.
3312                Otherwise, this resets the expressions.
3313            join_type: if set, alter the parsed join type.
3314            join_alias: an optional alias for the joined source.
3315            dialect: the dialect used to parse the input expressions.
3316            copy: if `False`, modify this expression instance in-place.
3317            opts: other options to use to parse the input expressions.
3318
3319        Returns:
3320            Select: the modified expression.
3321        """
3322        parse_args: t.Dict[str, t.Any] = {"dialect": dialect, **opts}
3323
3324        try:
3325            expression = maybe_parse(expression, into=Join, prefix="JOIN", **parse_args)
3326        except ParseError:
3327            expression = maybe_parse(expression, into=(Join, Expression), **parse_args)
3328
3329        join = expression if isinstance(expression, Join) else Join(this=expression)
3330
3331        if isinstance(join.this, Select):
3332            join.this.replace(join.this.subquery())
3333
3334        if join_type:
3335            method: t.Optional[Token]
3336            side: t.Optional[Token]
3337            kind: t.Optional[Token]
3338
3339            method, side, kind = maybe_parse(join_type, into="JOIN_TYPE", **parse_args)  # type: ignore
3340
3341            if method:
3342                join.set("method", method.text)
3343            if side:
3344                join.set("side", side.text)
3345            if kind:
3346                join.set("kind", kind.text)
3347
3348        if on:
3349            on = and_(*ensure_list(on), dialect=dialect, copy=copy, **opts)
3350            join.set("on", on)
3351
3352        if using:
3353            join = _apply_list_builder(
3354                *ensure_list(using),
3355                instance=join,
3356                arg="using",
3357                append=append,
3358                copy=copy,
3359                into=Identifier,
3360                **opts,
3361            )
3362
3363        if join_alias:
3364            join.set("this", alias_(join.this, join_alias, table=True))
3365
3366        return _apply_list_builder(
3367            join,
3368            instance=self,
3369            arg="joins",
3370            append=append,
3371            copy=copy,
3372            **opts,
3373        )
3374
3375    def where(
3376        self,
3377        *expressions: t.Optional[ExpOrStr],
3378        append: bool = True,
3379        dialect: DialectType = None,
3380        copy: bool = True,
3381        **opts,
3382    ) -> Select:
3383        """
3384        Append to or set the WHERE expressions.
3385
3386        Example:
3387            >>> Select().select("x").from_("tbl").where("x = 'a' OR x < 'b'").sql()
3388            "SELECT x FROM tbl WHERE x = 'a' OR x < 'b'"
3389
3390        Args:
3391            *expressions: the SQL code strings to parse.
3392                If an `Expression` instance is passed, it will be used as-is.
3393                Multiple expressions are combined with an AND operator.
3394            append: if `True`, AND the new expressions to any existing expression.
3395                Otherwise, this resets the expression.
3396            dialect: the dialect used to parse the input expressions.
3397            copy: if `False`, modify this expression instance in-place.
3398            opts: other options to use to parse the input expressions.
3399
3400        Returns:
3401            Select: the modified expression.
3402        """
3403        return _apply_conjunction_builder(
3404            *expressions,
3405            instance=self,
3406            arg="where",
3407            append=append,
3408            into=Where,
3409            dialect=dialect,
3410            copy=copy,
3411            **opts,
3412        )
3413
3414    def having(
3415        self,
3416        *expressions: t.Optional[ExpOrStr],
3417        append: bool = True,
3418        dialect: DialectType = None,
3419        copy: bool = True,
3420        **opts,
3421    ) -> Select:
3422        """
3423        Append to or set the HAVING expressions.
3424
3425        Example:
3426            >>> Select().select("x", "COUNT(y)").from_("tbl").group_by("x").having("COUNT(y) > 3").sql()
3427            'SELECT x, COUNT(y) FROM tbl GROUP BY x HAVING COUNT(y) > 3'
3428
3429        Args:
3430            *expressions: the SQL code strings to parse.
3431                If an `Expression` instance is passed, it will be used as-is.
3432                Multiple expressions are combined with an AND operator.
3433            append: if `True`, AND the new expressions to any existing expression.
3434                Otherwise, this resets the expression.
3435            dialect: the dialect used to parse the input expressions.
3436            copy: if `False`, modify this expression instance in-place.
3437            opts: other options to use to parse the input expressions.
3438
3439        Returns:
3440            The modified Select expression.
3441        """
3442        return _apply_conjunction_builder(
3443            *expressions,
3444            instance=self,
3445            arg="having",
3446            append=append,
3447            into=Having,
3448            dialect=dialect,
3449            copy=copy,
3450            **opts,
3451        )
3452
3453    def window(
3454        self,
3455        *expressions: t.Optional[ExpOrStr],
3456        append: bool = True,
3457        dialect: DialectType = None,
3458        copy: bool = True,
3459        **opts,
3460    ) -> Select:
3461        return _apply_list_builder(
3462            *expressions,
3463            instance=self,
3464            arg="windows",
3465            append=append,
3466            into=Window,
3467            dialect=dialect,
3468            copy=copy,
3469            **opts,
3470        )
3471
3472    def qualify(
3473        self,
3474        *expressions: t.Optional[ExpOrStr],
3475        append: bool = True,
3476        dialect: DialectType = None,
3477        copy: bool = True,
3478        **opts,
3479    ) -> Select:
3480        return _apply_conjunction_builder(
3481            *expressions,
3482            instance=self,
3483            arg="qualify",
3484            append=append,
3485            into=Qualify,
3486            dialect=dialect,
3487            copy=copy,
3488            **opts,
3489        )
3490
3491    def distinct(
3492        self, *ons: t.Optional[ExpOrStr], distinct: bool = True, copy: bool = True
3493    ) -> Select:
3494        """
3495        Set the OFFSET expression.
3496
3497        Example:
3498            >>> Select().from_("tbl").select("x").distinct().sql()
3499            'SELECT DISTINCT x FROM tbl'
3500
3501        Args:
3502            ons: the expressions to distinct on
3503            distinct: whether the Select should be distinct
3504            copy: if `False`, modify this expression instance in-place.
3505
3506        Returns:
3507            Select: the modified expression.
3508        """
3509        instance = maybe_copy(self, copy)
3510        on = Tuple(expressions=[maybe_parse(on, copy=copy) for on in ons if on]) if ons else None
3511        instance.set("distinct", Distinct(on=on) if distinct else None)
3512        return instance
3513
3514    def ctas(
3515        self,
3516        table: ExpOrStr,
3517        properties: t.Optional[t.Dict] = None,
3518        dialect: DialectType = None,
3519        copy: bool = True,
3520        **opts,
3521    ) -> Create:
3522        """
3523        Convert this expression to a CREATE TABLE AS statement.
3524
3525        Example:
3526            >>> Select().select("*").from_("tbl").ctas("x").sql()
3527            'CREATE TABLE x AS SELECT * FROM tbl'
3528
3529        Args:
3530            table: the SQL code string to parse as the table name.
3531                If another `Expression` instance is passed, it will be used as-is.
3532            properties: an optional mapping of table properties
3533            dialect: the dialect used to parse the input table.
3534            copy: if `False`, modify this expression instance in-place.
3535            opts: other options to use to parse the input table.
3536
3537        Returns:
3538            The new Create expression.
3539        """
3540        instance = maybe_copy(self, copy)
3541        table_expression = maybe_parse(table, into=Table, dialect=dialect, **opts)
3542
3543        properties_expression = None
3544        if properties:
3545            properties_expression = Properties.from_dict(properties)
3546
3547        return Create(
3548            this=table_expression,
3549            kind="TABLE",
3550            expression=instance,
3551            properties=properties_expression,
3552        )
3553
3554    def lock(self, update: bool = True, copy: bool = True) -> Select:
3555        """
3556        Set the locking read mode for this expression.
3557
3558        Examples:
3559            >>> Select().select("x").from_("tbl").where("x = 'a'").lock().sql("mysql")
3560            "SELECT x FROM tbl WHERE x = 'a' FOR UPDATE"
3561
3562            >>> Select().select("x").from_("tbl").where("x = 'a'").lock(update=False).sql("mysql")
3563            "SELECT x FROM tbl WHERE x = 'a' FOR SHARE"
3564
3565        Args:
3566            update: if `True`, the locking type will be `FOR UPDATE`, else it will be `FOR SHARE`.
3567            copy: if `False`, modify this expression instance in-place.
3568
3569        Returns:
3570            The modified expression.
3571        """
3572        inst = maybe_copy(self, copy)
3573        inst.set("locks", [Lock(update=update)])
3574
3575        return inst
3576
3577    def hint(self, *hints: ExpOrStr, dialect: DialectType = None, copy: bool = True) -> Select:
3578        """
3579        Set hints for this expression.
3580
3581        Examples:
3582            >>> Select().select("x").from_("tbl").hint("BROADCAST(y)").sql(dialect="spark")
3583            'SELECT /*+ BROADCAST(y) */ x FROM tbl'
3584
3585        Args:
3586            hints: The SQL code strings to parse as the hints.
3587                If an `Expression` instance is passed, it will be used as-is.
3588            dialect: The dialect used to parse the hints.
3589            copy: If `False`, modify this expression instance in-place.
3590
3591        Returns:
3592            The modified expression.
3593        """
3594        inst = maybe_copy(self, copy)
3595        inst.set(
3596            "hint", Hint(expressions=[maybe_parse(h, copy=copy, dialect=dialect) for h in hints])
3597        )
3598
3599        return inst
3600
3601    @property
3602    def named_selects(self) -> t.List[str]:
3603        return [e.output_name for e in self.expressions if e.alias_or_name]
3604
3605    @property
3606    def is_star(self) -> bool:
3607        return any(expression.is_star for expression in self.expressions)
3608
3609    @property
3610    def selects(self) -> t.List[Expression]:
3611        return self.expressions
3612
3613
3614UNWRAPPED_QUERIES = (Select, Union)
3615
3616
3617class Subquery(DerivedTable, Query):
3618    arg_types = {
3619        "this": True,
3620        "alias": False,
3621        "with": False,
3622        **QUERY_MODIFIERS,
3623    }
3624
3625    def unnest(self):
3626        """Returns the first non subquery."""
3627        expression = self
3628        while isinstance(expression, Subquery):
3629            expression = expression.this
3630        return expression
3631
3632    def unwrap(self) -> Subquery:
3633        expression = self
3634        while expression.same_parent and expression.is_wrapper:
3635            expression = t.cast(Subquery, expression.parent)
3636        return expression
3637
3638    def select(
3639        self,
3640        *expressions: t.Optional[ExpOrStr],
3641        append: bool = True,
3642        dialect: DialectType = None,
3643        copy: bool = True,
3644        **opts,
3645    ) -> Subquery:
3646        this = maybe_copy(self, copy)
3647        this.unnest().select(*expressions, append=append, dialect=dialect, copy=False, **opts)
3648        return this
3649
3650    @property
3651    def is_wrapper(self) -> bool:
3652        """
3653        Whether this Subquery acts as a simple wrapper around another expression.
3654
3655        SELECT * FROM (((SELECT * FROM t)))
3656                      ^
3657                      This corresponds to a "wrapper" Subquery node
3658        """
3659        return all(v is None for k, v in self.args.items() if k != "this")
3660
3661    @property
3662    def is_star(self) -> bool:
3663        return self.this.is_star
3664
3665    @property
3666    def output_name(self) -> str:
3667        return self.alias
3668
3669
3670class TableSample(Expression):
3671    arg_types = {
3672        "this": False,
3673        "expressions": False,
3674        "method": False,
3675        "bucket_numerator": False,
3676        "bucket_denominator": False,
3677        "bucket_field": False,
3678        "percent": False,
3679        "rows": False,
3680        "size": False,
3681        "seed": False,
3682    }
3683
3684
3685class Tag(Expression):
3686    """Tags are used for generating arbitrary sql like SELECT <span>x</span>."""
3687
3688    arg_types = {
3689        "this": False,
3690        "prefix": False,
3691        "postfix": False,
3692    }
3693
3694
3695# Represents both the standard SQL PIVOT operator and DuckDB's "simplified" PIVOT syntax
3696# https://duckdb.org/docs/sql/statements/pivot
3697class Pivot(Expression):
3698    arg_types = {
3699        "this": False,
3700        "alias": False,
3701        "expressions": False,
3702        "field": False,
3703        "unpivot": False,
3704        "using": False,
3705        "group": False,
3706        "columns": False,
3707        "include_nulls": False,
3708    }
3709
3710    @property
3711    def unpivot(self) -> bool:
3712        return bool(self.args.get("unpivot"))
3713
3714
3715class Window(Condition):
3716    arg_types = {
3717        "this": True,
3718        "partition_by": False,
3719        "order": False,
3720        "spec": False,
3721        "alias": False,
3722        "over": False,
3723        "first": False,
3724    }
3725
3726
3727class WindowSpec(Expression):
3728    arg_types = {
3729        "kind": False,
3730        "start": False,
3731        "start_side": False,
3732        "end": False,
3733        "end_side": False,
3734    }
3735
3736
3737class PreWhere(Expression):
3738    pass
3739
3740
3741class Where(Expression):
3742    pass
3743
3744
3745class Star(Expression):
3746    arg_types = {"except": False, "replace": False}
3747
3748    @property
3749    def name(self) -> str:
3750        return "*"
3751
3752    @property
3753    def output_name(self) -> str:
3754        return self.name
3755
3756
3757class Parameter(Condition):
3758    arg_types = {"this": True, "expression": False}
3759
3760
3761class SessionParameter(Condition):
3762    arg_types = {"this": True, "kind": False}
3763
3764
3765class Placeholder(Condition):
3766    arg_types = {"this": False, "kind": False}
3767
3768
3769class Null(Condition):
3770    arg_types: t.Dict[str, t.Any] = {}
3771
3772    @property
3773    def name(self) -> str:
3774        return "NULL"
3775
3776
3777class Boolean(Condition):
3778    pass
3779
3780
3781class DataTypeParam(Expression):
3782    arg_types = {"this": True, "expression": False}
3783
3784    @property
3785    def name(self) -> str:
3786        return self.this.name
3787
3788
3789class DataType(Expression):
3790    arg_types = {
3791        "this": True,
3792        "expressions": False,
3793        "nested": False,
3794        "values": False,
3795        "prefix": False,
3796        "kind": False,
3797    }
3798
3799    class Type(AutoName):
3800        ARRAY = auto()
3801        AGGREGATEFUNCTION = auto()
3802        SIMPLEAGGREGATEFUNCTION = auto()
3803        BIGDECIMAL = auto()
3804        BIGINT = auto()
3805        BIGSERIAL = auto()
3806        BINARY = auto()
3807        BIT = auto()
3808        BOOLEAN = auto()
3809        BPCHAR = auto()
3810        CHAR = auto()
3811        DATE = auto()
3812        DATE32 = auto()
3813        DATEMULTIRANGE = auto()
3814        DATERANGE = auto()
3815        DATETIME = auto()
3816        DATETIME64 = auto()
3817        DECIMAL = auto()
3818        DOUBLE = auto()
3819        ENUM = auto()
3820        ENUM8 = auto()
3821        ENUM16 = auto()
3822        FIXEDSTRING = auto()
3823        FLOAT = auto()
3824        GEOGRAPHY = auto()
3825        GEOMETRY = auto()
3826        HLLSKETCH = auto()
3827        HSTORE = auto()
3828        IMAGE = auto()
3829        INET = auto()
3830        INT = auto()
3831        INT128 = auto()
3832        INT256 = auto()
3833        INT4MULTIRANGE = auto()
3834        INT4RANGE = auto()
3835        INT8MULTIRANGE = auto()
3836        INT8RANGE = auto()
3837        INTERVAL = auto()
3838        IPADDRESS = auto()
3839        IPPREFIX = auto()
3840        IPV4 = auto()
3841        IPV6 = auto()
3842        JSON = auto()
3843        JSONB = auto()
3844        LONGBLOB = auto()
3845        LONGTEXT = auto()
3846        LOWCARDINALITY = auto()
3847        MAP = auto()
3848        MEDIUMBLOB = auto()
3849        MEDIUMINT = auto()
3850        MEDIUMTEXT = auto()
3851        MONEY = auto()
3852        NAME = auto()
3853        NCHAR = auto()
3854        NESTED = auto()
3855        NULL = auto()
3856        NULLABLE = auto()
3857        NUMMULTIRANGE = auto()
3858        NUMRANGE = auto()
3859        NVARCHAR = auto()
3860        OBJECT = auto()
3861        ROWVERSION = auto()
3862        SERIAL = auto()
3863        SET = auto()
3864        SMALLINT = auto()
3865        SMALLMONEY = auto()
3866        SMALLSERIAL = auto()
3867        STRUCT = auto()
3868        SUPER = auto()
3869        TEXT = auto()
3870        TINYBLOB = auto()
3871        TINYTEXT = auto()
3872        TIME = auto()
3873        TIMETZ = auto()
3874        TIMESTAMP = auto()
3875        TIMESTAMPLTZ = auto()
3876        TIMESTAMPTZ = auto()
3877        TIMESTAMP_S = auto()
3878        TIMESTAMP_MS = auto()
3879        TIMESTAMP_NS = auto()
3880        TINYINT = auto()
3881        TSMULTIRANGE = auto()
3882        TSRANGE = auto()
3883        TSTZMULTIRANGE = auto()
3884        TSTZRANGE = auto()
3885        UBIGINT = auto()
3886        UINT = auto()
3887        UINT128 = auto()
3888        UINT256 = auto()
3889        UMEDIUMINT = auto()
3890        UDECIMAL = auto()
3891        UNIQUEIDENTIFIER = auto()
3892        UNKNOWN = auto()  # Sentinel value, useful for type annotation
3893        USERDEFINED = "USER-DEFINED"
3894        USMALLINT = auto()
3895        UTINYINT = auto()
3896        UUID = auto()
3897        VARBINARY = auto()
3898        VARCHAR = auto()
3899        VARIANT = auto()
3900        XML = auto()
3901        YEAR = auto()
3902
3903    STRUCT_TYPES = {
3904        Type.NESTED,
3905        Type.OBJECT,
3906        Type.STRUCT,
3907    }
3908
3909    NESTED_TYPES = {
3910        *STRUCT_TYPES,
3911        Type.ARRAY,
3912        Type.MAP,
3913    }
3914
3915    TEXT_TYPES = {
3916        Type.CHAR,
3917        Type.NCHAR,
3918        Type.NVARCHAR,
3919        Type.TEXT,
3920        Type.VARCHAR,
3921        Type.NAME,
3922    }
3923
3924    INTEGER_TYPES = {
3925        Type.BIGINT,
3926        Type.BIT,
3927        Type.INT,
3928        Type.INT128,
3929        Type.INT256,
3930        Type.MEDIUMINT,
3931        Type.SMALLINT,
3932        Type.TINYINT,
3933        Type.UBIGINT,
3934        Type.UINT,
3935        Type.UINT128,
3936        Type.UINT256,
3937        Type.UMEDIUMINT,
3938        Type.USMALLINT,
3939        Type.UTINYINT,
3940    }
3941
3942    FLOAT_TYPES = {
3943        Type.DOUBLE,
3944        Type.FLOAT,
3945    }
3946
3947    REAL_TYPES = {
3948        *FLOAT_TYPES,
3949        Type.BIGDECIMAL,
3950        Type.DECIMAL,
3951        Type.MONEY,
3952        Type.SMALLMONEY,
3953        Type.UDECIMAL,
3954    }
3955
3956    NUMERIC_TYPES = {
3957        *INTEGER_TYPES,
3958        *REAL_TYPES,
3959    }
3960
3961    TEMPORAL_TYPES = {
3962        Type.DATE,
3963        Type.DATE32,
3964        Type.DATETIME,
3965        Type.DATETIME64,
3966        Type.TIME,
3967        Type.TIMESTAMP,
3968        Type.TIMESTAMPLTZ,
3969        Type.TIMESTAMPTZ,
3970        Type.TIMESTAMP_MS,
3971        Type.TIMESTAMP_NS,
3972        Type.TIMESTAMP_S,
3973        Type.TIMETZ,
3974    }
3975
3976    @classmethod
3977    def build(
3978        cls,
3979        dtype: DATA_TYPE,
3980        dialect: DialectType = None,
3981        udt: bool = False,
3982        copy: bool = True,
3983        **kwargs,
3984    ) -> DataType:
3985        """
3986        Constructs a DataType object.
3987
3988        Args:
3989            dtype: the data type of interest.
3990            dialect: the dialect to use for parsing `dtype`, in case it's a string.
3991            udt: when set to True, `dtype` will be used as-is if it can't be parsed into a
3992                DataType, thus creating a user-defined type.
3993            copy: whether to copy the data type.
3994            kwargs: additional arguments to pass in the constructor of DataType.
3995
3996        Returns:
3997            The constructed DataType object.
3998        """
3999        from sqlglot import parse_one
4000
4001        if isinstance(dtype, str):
4002            if dtype.upper() == "UNKNOWN":
4003                return DataType(this=DataType.Type.UNKNOWN, **kwargs)
4004
4005            try:
4006                data_type_exp = parse_one(
4007                    dtype, read=dialect, into=DataType, error_level=ErrorLevel.IGNORE
4008                )
4009            except ParseError:
4010                if udt:
4011                    return DataType(this=DataType.Type.USERDEFINED, kind=dtype, **kwargs)
4012                raise
4013        elif isinstance(dtype, DataType.Type):
4014            data_type_exp = DataType(this=dtype)
4015        elif isinstance(dtype, DataType):
4016            return maybe_copy(dtype, copy)
4017        else:
4018            raise ValueError(f"Invalid data type: {type(dtype)}. Expected str or DataType.Type")
4019
4020        return DataType(**{**data_type_exp.args, **kwargs})
4021
4022    def is_type(self, *dtypes: DATA_TYPE) -> bool:
4023        """
4024        Checks whether this DataType matches one of the provided data types. Nested types or precision
4025        will be compared using "structural equivalence" semantics, so e.g. array<int> != array<float>.
4026
4027        Args:
4028            dtypes: the data types to compare this DataType to.
4029
4030        Returns:
4031            True, if and only if there is a type in `dtypes` which is equal to this DataType.
4032        """
4033        for dtype in dtypes:
4034            other = DataType.build(dtype, copy=False, udt=True)
4035
4036            if (
4037                other.expressions
4038                or self.this == DataType.Type.USERDEFINED
4039                or other.this == DataType.Type.USERDEFINED
4040            ):
4041                matches = self == other
4042            else:
4043                matches = self.this == other.this
4044
4045            if matches:
4046                return True
4047        return False
4048
4049
4050DATA_TYPE = t.Union[str, DataType, DataType.Type]
4051
4052
4053# https://www.postgresql.org/docs/15/datatype-pseudo.html
4054class PseudoType(DataType):
4055    arg_types = {"this": True}
4056
4057
4058# https://www.postgresql.org/docs/15/datatype-oid.html
4059class ObjectIdentifier(DataType):
4060    arg_types = {"this": True}
4061
4062
4063# WHERE x <OP> EXISTS|ALL|ANY|SOME(SELECT ...)
4064class SubqueryPredicate(Predicate):
4065    pass
4066
4067
4068class All(SubqueryPredicate):
4069    pass
4070
4071
4072class Any(SubqueryPredicate):
4073    pass
4074
4075
4076class Exists(SubqueryPredicate):
4077    pass
4078
4079
4080# Commands to interact with the databases or engines. For most of the command
4081# expressions we parse whatever comes after the command's name as a string.
4082class Command(Expression):
4083    arg_types = {"this": True, "expression": False}
4084
4085
4086class Transaction(Expression):
4087    arg_types = {"this": False, "modes": False, "mark": False}
4088
4089
4090class Commit(Expression):
4091    arg_types = {"chain": False, "this": False, "durability": False}
4092
4093
4094class Rollback(Expression):
4095    arg_types = {"savepoint": False, "this": False}
4096
4097
4098class AlterTable(Expression):
4099    arg_types = {
4100        "this": True,
4101        "actions": True,
4102        "exists": False,
4103        "only": False,
4104        "options": False,
4105    }
4106
4107
4108class AddConstraint(Expression):
4109    arg_types = {"expressions": True}
4110
4111
4112class DropPartition(Expression):
4113    arg_types = {"expressions": True, "exists": False}
4114
4115
4116# Binary expressions like (ADD a b)
4117class Binary(Condition):
4118    arg_types = {"this": True, "expression": True}
4119
4120    @property
4121    def left(self) -> Expression:
4122        return self.this
4123
4124    @property
4125    def right(self) -> Expression:
4126        return self.expression
4127
4128
4129class Add(Binary):
4130    pass
4131
4132
4133class Connector(Binary):
4134    pass
4135
4136
4137class And(Connector):
4138    pass
4139
4140
4141class Or(Connector):
4142    pass
4143
4144
4145class BitwiseAnd(Binary):
4146    pass
4147
4148
4149class BitwiseLeftShift(Binary):
4150    pass
4151
4152
4153class BitwiseOr(Binary):
4154    pass
4155
4156
4157class BitwiseRightShift(Binary):
4158    pass
4159
4160
4161class BitwiseXor(Binary):
4162    pass
4163
4164
4165class Div(Binary):
4166    arg_types = {"this": True, "expression": True, "typed": False, "safe": False}
4167
4168
4169class Overlaps(Binary):
4170    pass
4171
4172
4173class Dot(Binary):
4174    @property
4175    def is_star(self) -> bool:
4176        return self.expression.is_star
4177
4178    @property
4179    def name(self) -> str:
4180        return self.expression.name
4181
4182    @property
4183    def output_name(self) -> str:
4184        return self.name
4185
4186    @classmethod
4187    def build(self, expressions: t.Sequence[Expression]) -> Dot:
4188        """Build a Dot object with a sequence of expressions."""
4189        if len(expressions) < 2:
4190            raise ValueError("Dot requires >= 2 expressions.")
4191
4192        return t.cast(Dot, reduce(lambda x, y: Dot(this=x, expression=y), expressions))
4193
4194    @property
4195    def parts(self) -> t.List[Expression]:
4196        """Return the parts of a table / column in order catalog, db, table."""
4197        this, *parts = self.flatten()
4198
4199        parts.reverse()
4200
4201        for arg in ("this", "table", "db", "catalog"):
4202            part = this.args.get(arg)
4203
4204            if isinstance(part, Expression):
4205                parts.append(part)
4206
4207        parts.reverse()
4208        return parts
4209
4210
4211class DPipe(Binary):
4212    arg_types = {"this": True, "expression": True, "safe": False}
4213
4214
4215class EQ(Binary, Predicate):
4216    pass
4217
4218
4219class NullSafeEQ(Binary, Predicate):
4220    pass
4221
4222
4223class NullSafeNEQ(Binary, Predicate):
4224    pass
4225
4226
4227# Represents e.g. := in DuckDB which is mostly used for setting parameters
4228class PropertyEQ(Binary):
4229    pass
4230
4231
4232class Distance(Binary):
4233    pass
4234
4235
4236class Escape(Binary):
4237    pass
4238
4239
4240class Glob(Binary, Predicate):
4241    pass
4242
4243
4244class GT(Binary, Predicate):
4245    pass
4246
4247
4248class GTE(Binary, Predicate):
4249    pass
4250
4251
4252class ILike(Binary, Predicate):
4253    pass
4254
4255
4256class ILikeAny(Binary, Predicate):
4257    pass
4258
4259
4260class IntDiv(Binary):
4261    pass
4262
4263
4264class Is(Binary, Predicate):
4265    pass
4266
4267
4268class Kwarg(Binary):
4269    """Kwarg in special functions like func(kwarg => y)."""
4270
4271
4272class Like(Binary, Predicate):
4273    pass
4274
4275
4276class LikeAny(Binary, Predicate):
4277    pass
4278
4279
4280class LT(Binary, Predicate):
4281    pass
4282
4283
4284class LTE(Binary, Predicate):
4285    pass
4286
4287
4288class Mod(Binary):
4289    pass
4290
4291
4292class Mul(Binary):
4293    pass
4294
4295
4296class NEQ(Binary, Predicate):
4297    pass
4298
4299
4300# https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PATH
4301class Operator(Binary):
4302    arg_types = {"this": True, "operator": True, "expression": True}
4303
4304
4305class SimilarTo(Binary, Predicate):
4306    pass
4307
4308
4309class Slice(Binary):
4310    arg_types = {"this": False, "expression": False}
4311
4312
4313class Sub(Binary):
4314    pass
4315
4316
4317# Unary Expressions
4318# (NOT a)
4319class Unary(Condition):
4320    pass
4321
4322
4323class BitwiseNot(Unary):
4324    pass
4325
4326
4327class Not(Unary):
4328    pass
4329
4330
4331class Paren(Unary):
4332    @property
4333    def output_name(self) -> str:
4334        return self.this.name
4335
4336
4337class Neg(Unary):
4338    pass
4339
4340
4341class Alias(Expression):
4342    arg_types = {"this": True, "alias": False}
4343
4344    @property
4345    def output_name(self) -> str:
4346        return self.alias
4347
4348
4349# BigQuery requires the UNPIVOT column list aliases to be either strings or ints, but
4350# other dialects require identifiers. This enables us to transpile between them easily.
4351class PivotAlias(Alias):
4352    pass
4353
4354
4355class Aliases(Expression):
4356    arg_types = {"this": True, "expressions": True}
4357
4358    @property
4359    def aliases(self):
4360        return self.expressions
4361
4362
4363# https://docs.aws.amazon.com/redshift/latest/dg/query-super.html
4364class AtIndex(Expression):
4365    arg_types = {"this": True, "expression": True}
4366
4367
4368class AtTimeZone(Expression):
4369    arg_types = {"this": True, "zone": True}
4370
4371
4372class FromTimeZone(Expression):
4373    arg_types = {"this": True, "zone": True}
4374
4375
4376class Between(Predicate):
4377    arg_types = {"this": True, "low": True, "high": True}
4378
4379
4380class Bracket(Condition):
4381    # https://cloud.google.com/bigquery/docs/reference/standard-sql/operators#array_subscript_operator
4382    arg_types = {"this": True, "expressions": True, "offset": False, "safe": False}
4383
4384    @property
4385    def output_name(self) -> str:
4386        if len(self.expressions) == 1:
4387            return self.expressions[0].output_name
4388
4389        return super().output_name
4390
4391
4392class Distinct(Expression):
4393    arg_types = {"expressions": False, "on": False}
4394
4395
4396class In(Predicate):
4397    arg_types = {
4398        "this": True,
4399        "expressions": False,
4400        "query": False,
4401        "unnest": False,
4402        "field": False,
4403        "is_global": False,
4404    }
4405
4406
4407# https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#for-in
4408class ForIn(Expression):
4409    arg_types = {"this": True, "expression": True}
4410
4411
4412class TimeUnit(Expression):
4413    """Automatically converts unit arg into a var."""
4414
4415    arg_types = {"unit": False}
4416
4417    UNABBREVIATED_UNIT_NAME = {
4418        "D": "DAY",
4419        "H": "HOUR",
4420        "M": "MINUTE",
4421        "MS": "MILLISECOND",
4422        "NS": "NANOSECOND",
4423        "Q": "QUARTER",
4424        "S": "SECOND",
4425        "US": "MICROSECOND",
4426        "W": "WEEK",
4427        "Y": "YEAR",
4428    }
4429
4430    VAR_LIKE = (Column, Literal, Var)
4431
4432    def __init__(self, **args):
4433        unit = args.get("unit")
4434        if isinstance(unit, self.VAR_LIKE):
4435            args["unit"] = Var(
4436                this=(self.UNABBREVIATED_UNIT_NAME.get(unit.name) or unit.name).upper()
4437            )
4438        elif isinstance(unit, Week):
4439            unit.set("this", Var(this=unit.this.name.upper()))
4440
4441        super().__init__(**args)
4442
4443    @property
4444    def unit(self) -> t.Optional[Var]:
4445        return self.args.get("unit")
4446
4447
4448class IntervalOp(TimeUnit):
4449    arg_types = {"unit": True, "expression": True}
4450
4451    def interval(self):
4452        return Interval(
4453            this=self.expression.copy(),
4454            unit=self.unit.copy(),
4455        )
4456
4457
4458# https://www.oracletutorial.com/oracle-basics/oracle-interval/
4459# https://trino.io/docs/current/language/types.html#interval-day-to-second
4460# https://docs.databricks.com/en/sql/language-manual/data-types/interval-type.html
4461class IntervalSpan(DataType):
4462    arg_types = {"this": True, "expression": True}
4463
4464
4465class Interval(TimeUnit):
4466    arg_types = {"this": False, "unit": False}
4467
4468
4469class IgnoreNulls(Expression):
4470    pass
4471
4472
4473class RespectNulls(Expression):
4474    pass
4475
4476
4477# https://cloud.google.com/bigquery/docs/reference/standard-sql/aggregate-function-calls#max_min_clause
4478class HavingMax(Expression):
4479    arg_types = {"this": True, "expression": True, "max": True}
4480
4481
4482# Functions
4483class Func(Condition):
4484    """
4485    The base class for all function expressions.
4486
4487    Attributes:
4488        is_var_len_args (bool): if set to True the last argument defined in arg_types will be
4489            treated as a variable length argument and the argument's value will be stored as a list.
4490        _sql_names (list): the SQL name (1st item in the list) and aliases (subsequent items) for this
4491            function expression. These values are used to map this node to a name during parsing as
4492            well as to provide the function's name during SQL string generation. By default the SQL
4493            name is set to the expression's class name transformed to snake case.
4494    """
4495
4496    is_var_len_args = False
4497
4498    @classmethod
4499    def from_arg_list(cls, args):
4500        if cls.is_var_len_args:
4501            all_arg_keys = list(cls.arg_types)
4502            # If this function supports variable length argument treat the last argument as such.
4503            non_var_len_arg_keys = all_arg_keys[:-1] if cls.is_var_len_args else all_arg_keys
4504            num_non_var = len(non_var_len_arg_keys)
4505
4506            args_dict = {arg_key: arg for arg, arg_key in zip(args, non_var_len_arg_keys)}
4507            args_dict[all_arg_keys[-1]] = args[num_non_var:]
4508        else:
4509            args_dict = {arg_key: arg for arg, arg_key in zip(args, cls.arg_types)}
4510
4511        return cls(**args_dict)
4512
4513    @classmethod
4514    def sql_names(cls):
4515        if cls is Func:
4516            raise NotImplementedError(
4517                "SQL name is only supported by concrete function implementations"
4518            )
4519        if "_sql_names" not in cls.__dict__:
4520            cls._sql_names = [camel_to_snake_case(cls.__name__)]
4521        return cls._sql_names
4522
4523    @classmethod
4524    def sql_name(cls):
4525        return cls.sql_names()[0]
4526
4527    @classmethod
4528    def default_parser_mappings(cls):
4529        return {name: cls.from_arg_list for name in cls.sql_names()}
4530
4531
4532class AggFunc(Func):
4533    pass
4534
4535
4536class ParameterizedAgg(AggFunc):
4537    arg_types = {"this": True, "expressions": True, "params": True}
4538
4539
4540class Abs(Func):
4541    pass
4542
4543
4544class ArgMax(AggFunc):
4545    arg_types = {"this": True, "expression": True, "count": False}
4546    _sql_names = ["ARG_MAX", "ARGMAX", "MAX_BY"]
4547
4548
4549class ArgMin(AggFunc):
4550    arg_types = {"this": True, "expression": True, "count": False}
4551    _sql_names = ["ARG_MIN", "ARGMIN", "MIN_BY"]
4552
4553
4554class ApproxTopK(AggFunc):
4555    arg_types = {"this": True, "expression": False, "counters": False}
4556
4557
4558class Flatten(Func):
4559    pass
4560
4561
4562# https://spark.apache.org/docs/latest/api/sql/index.html#transform
4563class Transform(Func):
4564    arg_types = {"this": True, "expression": True}
4565
4566
4567class Anonymous(Func):
4568    arg_types = {"this": True, "expressions": False}
4569    is_var_len_args = True
4570
4571    @property
4572    def name(self) -> str:
4573        return self.this if isinstance(self.this, str) else self.this.name
4574
4575
4576class AnonymousAggFunc(AggFunc):
4577    arg_types = {"this": True, "expressions": False}
4578    is_var_len_args = True
4579
4580
4581# https://clickhouse.com/docs/en/sql-reference/aggregate-functions/combinators
4582class CombinedAggFunc(AnonymousAggFunc):
4583    arg_types = {"this": True, "expressions": False, "parts": True}
4584
4585
4586class CombinedParameterizedAgg(ParameterizedAgg):
4587    arg_types = {"this": True, "expressions": True, "params": True, "parts": True}
4588
4589
4590# https://docs.snowflake.com/en/sql-reference/functions/hll
4591# https://docs.aws.amazon.com/redshift/latest/dg/r_HLL_function.html
4592class Hll(AggFunc):
4593    arg_types = {"this": True, "expressions": False}
4594    is_var_len_args = True
4595
4596
4597class ApproxDistinct(AggFunc):
4598    arg_types = {"this": True, "accuracy": False}
4599    _sql_names = ["APPROX_DISTINCT", "APPROX_COUNT_DISTINCT"]
4600
4601
4602class Array(Func):
4603    arg_types = {"expressions": False}
4604    is_var_len_args = True
4605
4606
4607# https://docs.snowflake.com/en/sql-reference/functions/to_array
4608class ToArray(Func):
4609    pass
4610
4611
4612# https://docs.snowflake.com/en/sql-reference/functions/to_char
4613# https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/TO_CHAR-number.html
4614class ToChar(Func):
4615    arg_types = {"this": True, "format": False, "nlsparam": False}
4616
4617
4618# https://docs.snowflake.com/en/sql-reference/functions/to_decimal
4619# https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/TO_NUMBER.html
4620class ToNumber(Func):
4621    arg_types = {
4622        "this": True,
4623        "format": False,
4624        "nlsparam": False,
4625        "precision": False,
4626        "scale": False,
4627    }
4628
4629
4630# https://learn.microsoft.com/en-us/sql/t-sql/functions/cast-and-convert-transact-sql?view=sql-server-ver16#syntax
4631class Convert(Func):
4632    arg_types = {"this": True, "expression": True, "style": False}
4633
4634
4635class GenerateSeries(Func):
4636    arg_types = {"start": True, "end": True, "step": False, "is_end_exclusive": False}
4637
4638
4639class ArrayAgg(AggFunc):
4640    pass
4641
4642
4643class ArrayUniqueAgg(AggFunc):
4644    pass
4645
4646
4647class ArrayAll(Func):
4648    arg_types = {"this": True, "expression": True}
4649
4650
4651# Represents Python's `any(f(x) for x in array)`, where `array` is `this` and `f` is `expression`
4652class ArrayAny(Func):
4653    arg_types = {"this": True, "expression": True}
4654
4655
4656class ArrayConcat(Func):
4657    _sql_names = ["ARRAY_CONCAT", "ARRAY_CAT"]
4658    arg_types = {"this": True, "expressions": False}
4659    is_var_len_args = True
4660
4661
4662class ArrayContains(Binary, Func):
4663    pass
4664
4665
4666class ArrayContained(Binary):
4667    pass
4668
4669
4670class ArrayFilter(Func):
4671    arg_types = {"this": True, "expression": True}
4672    _sql_names = ["FILTER", "ARRAY_FILTER"]
4673
4674
4675class ArrayToString(Func):
4676    arg_types = {"this": True, "expression": True, "null": False}
4677    _sql_names = ["ARRAY_TO_STRING", "ARRAY_JOIN"]
4678
4679
4680class ArrayOverlaps(Binary, Func):
4681    pass
4682
4683
4684class ArraySize(Func):
4685    arg_types = {"this": True, "expression": False}
4686    _sql_names = ["ARRAY_SIZE", "ARRAY_LENGTH"]
4687
4688
4689class ArraySort(Func):
4690    arg_types = {"this": True, "expression": False}
4691
4692
4693class ArraySum(Func):
4694    arg_types = {"this": True, "expression": False}
4695
4696
4697class ArrayUnionAgg(AggFunc):
4698    pass
4699
4700
4701class Avg(AggFunc):
4702    pass
4703
4704
4705class AnyValue(AggFunc):
4706    pass
4707
4708
4709class Lag(AggFunc):
4710    arg_types = {"this": True, "offset": False, "default": False}
4711
4712
4713class Lead(AggFunc):
4714    arg_types = {"this": True, "offset": False, "default": False}
4715
4716
4717# some dialects have a distinction between first and first_value, usually first is an aggregate func
4718# and first_value is a window func
4719class First(AggFunc):
4720    pass
4721
4722
4723class Last(AggFunc):
4724    pass
4725
4726
4727class FirstValue(AggFunc):
4728    pass
4729
4730
4731class LastValue(AggFunc):
4732    pass
4733
4734
4735class NthValue(AggFunc):
4736    arg_types = {"this": True, "offset": True}
4737
4738
4739class Case(Func):
4740    arg_types = {"this": False, "ifs": True, "default": False}
4741
4742    def when(self, condition: ExpOrStr, then: ExpOrStr, copy: bool = True, **opts) -> Case:
4743        instance = maybe_copy(self, copy)
4744        instance.append(
4745            "ifs",
4746            If(
4747                this=maybe_parse(condition, copy=copy, **opts),
4748                true=maybe_parse(then, copy=copy, **opts),
4749            ),
4750        )
4751        return instance
4752
4753    def else_(self, condition: ExpOrStr, copy: bool = True, **opts) -> Case:
4754        instance = maybe_copy(self, copy)
4755        instance.set("default", maybe_parse(condition, copy=copy, **opts))
4756        return instance
4757
4758
4759class Cast(Func):
4760    arg_types = {
4761        "this": True,
4762        "to": True,
4763        "format": False,
4764        "safe": False,
4765        "action": False,
4766    }
4767
4768    @property
4769    def name(self) -> str:
4770        return self.this.name
4771
4772    @property
4773    def to(self) -> DataType:
4774        return self.args["to"]
4775
4776    @property
4777    def output_name(self) -> str:
4778        return self.name
4779
4780    def is_type(self, *dtypes: DATA_TYPE) -> bool:
4781        """
4782        Checks whether this Cast's DataType matches one of the provided data types. Nested types
4783        like arrays or structs will be compared using "structural equivalence" semantics, so e.g.
4784        array<int> != array<float>.
4785
4786        Args:
4787            dtypes: the data types to compare this Cast's DataType to.
4788
4789        Returns:
4790            True, if and only if there is a type in `dtypes` which is equal to this Cast's DataType.
4791        """
4792        return self.to.is_type(*dtypes)
4793
4794
4795class TryCast(Cast):
4796    pass
4797
4798
4799class CastToStrType(Func):
4800    arg_types = {"this": True, "to": True}
4801
4802
4803class Collate(Binary, Func):
4804    pass
4805
4806
4807class Ceil(Func):
4808    arg_types = {"this": True, "decimals": False}
4809    _sql_names = ["CEIL", "CEILING"]
4810
4811
4812class Coalesce(Func):
4813    arg_types = {"this": True, "expressions": False}
4814    is_var_len_args = True
4815    _sql_names = ["COALESCE", "IFNULL", "NVL"]
4816
4817
4818class Chr(Func):
4819    arg_types = {"this": True, "charset": False, "expressions": False}
4820    is_var_len_args = True
4821    _sql_names = ["CHR", "CHAR"]
4822
4823
4824class Concat(Func):
4825    arg_types = {"expressions": True, "safe": False, "coalesce": False}
4826    is_var_len_args = True
4827
4828
4829class ConcatWs(Concat):
4830    _sql_names = ["CONCAT_WS"]
4831
4832
4833# https://docs.oracle.com/cd/B13789_01/server.101/b10759/operators004.htm#i1035022
4834class ConnectByRoot(Func):
4835    pass
4836
4837
4838class Count(AggFunc):
4839    arg_types = {"this": False, "expressions": False}
4840    is_var_len_args = True
4841
4842
4843class CountIf(AggFunc):
4844    _sql_names = ["COUNT_IF", "COUNTIF"]
4845
4846
4847# cube root
4848class Cbrt(Func):
4849    pass
4850
4851
4852class CurrentDate(Func):
4853    arg_types = {"this": False}
4854
4855
4856class CurrentDatetime(Func):
4857    arg_types = {"this": False}
4858
4859
4860class CurrentTime(Func):
4861    arg_types = {"this": False}
4862
4863
4864class CurrentTimestamp(Func):
4865    arg_types = {"this": False, "transaction": False}
4866
4867
4868class CurrentUser(Func):
4869    arg_types = {"this": False}
4870
4871
4872class DateAdd(Func, IntervalOp):
4873    arg_types = {"this": True, "expression": True, "unit": False}
4874
4875
4876class DateSub(Func, IntervalOp):
4877    arg_types = {"this": True, "expression": True, "unit": False}
4878
4879
4880class DateDiff(Func, TimeUnit):
4881    _sql_names = ["DATEDIFF", "DATE_DIFF"]
4882    arg_types = {"this": True, "expression": True, "unit": False}
4883
4884
4885class DateTrunc(Func):
4886    arg_types = {"unit": True, "this": True, "zone": False}
4887
4888    def __init__(self, **args):
4889        unit = args.get("unit")
4890        if isinstance(unit, TimeUnit.VAR_LIKE):
4891            args["unit"] = Literal.string(
4892                (TimeUnit.UNABBREVIATED_UNIT_NAME.get(unit.name) or unit.name).upper()
4893            )
4894        elif isinstance(unit, Week):
4895            unit.set("this", Literal.string(unit.this.name.upper()))
4896
4897        super().__init__(**args)
4898
4899    @property
4900    def unit(self) -> Expression:
4901        return self.args["unit"]
4902
4903
4904class DatetimeAdd(Func, IntervalOp):
4905    arg_types = {"this": True, "expression": True, "unit": False}
4906
4907
4908class DatetimeSub(Func, IntervalOp):
4909    arg_types = {"this": True, "expression": True, "unit": False}
4910
4911
4912class DatetimeDiff(Func, TimeUnit):
4913    arg_types = {"this": True, "expression": True, "unit": False}
4914
4915
4916class DatetimeTrunc(Func, TimeUnit):
4917    arg_types = {"this": True, "unit": True, "zone": False}
4918
4919
4920class DayOfWeek(Func):
4921    _sql_names = ["DAY_OF_WEEK", "DAYOFWEEK"]
4922
4923
4924class DayOfMonth(Func):
4925    _sql_names = ["DAY_OF_MONTH", "DAYOFMONTH"]
4926
4927
4928class DayOfYear(Func):
4929    _sql_names = ["DAY_OF_YEAR", "DAYOFYEAR"]
4930
4931
4932class ToDays(Func):
4933    pass
4934
4935
4936class WeekOfYear(Func):
4937    _sql_names = ["WEEK_OF_YEAR", "WEEKOFYEAR"]
4938
4939
4940class MonthsBetween(Func):
4941    arg_types = {"this": True, "expression": True, "roundoff": False}
4942
4943
4944class LastDay(Func, TimeUnit):
4945    _sql_names = ["LAST_DAY", "LAST_DAY_OF_MONTH"]
4946    arg_types = {"this": True, "unit": False}
4947
4948
4949class Extract(Func):
4950    arg_types = {"this": True, "expression": True}
4951
4952
4953class Timestamp(Func):
4954    arg_types = {"this": False, "expression": False, "with_tz": False}
4955
4956
4957class TimestampAdd(Func, TimeUnit):
4958    arg_types = {"this": True, "expression": True, "unit": False}
4959
4960
4961class TimestampSub(Func, TimeUnit):
4962    arg_types = {"this": True, "expression": True, "unit": False}
4963
4964
4965class TimestampDiff(Func, TimeUnit):
4966    _sql_names = ["TIMESTAMPDIFF", "TIMESTAMP_DIFF"]
4967    arg_types = {"this": True, "expression": True, "unit": False}
4968
4969
4970class TimestampTrunc(Func, TimeUnit):
4971    arg_types = {"this": True, "unit": True, "zone": False}
4972
4973
4974class TimeAdd(Func, TimeUnit):
4975    arg_types = {"this": True, "expression": True, "unit": False}
4976
4977
4978class TimeSub(Func, TimeUnit):
4979    arg_types = {"this": True, "expression": True, "unit": False}
4980
4981
4982class TimeDiff(Func, TimeUnit):
4983    arg_types = {"this": True, "expression": True, "unit": False}
4984
4985
4986class TimeTrunc(Func, TimeUnit):
4987    arg_types = {"this": True, "unit": True, "zone": False}
4988
4989
4990class DateFromParts(Func):
4991    _sql_names = ["DATE_FROM_PARTS", "DATEFROMPARTS"]
4992    arg_types = {"year": True, "month": True, "day": True}
4993
4994
4995class TimeFromParts(Func):
4996    _sql_names = ["TIME_FROM_PARTS", "TIMEFROMPARTS"]
4997    arg_types = {
4998        "hour": True,
4999        "min": True,
5000        "sec": True,
5001        "nano": False,
5002        "fractions": False,
5003        "precision": False,
5004    }
5005
5006
5007class DateStrToDate(Func):
5008    pass
5009
5010
5011class DateToDateStr(Func):
5012    pass
5013
5014
5015class DateToDi(Func):
5016    pass
5017
5018
5019# https://cloud.google.com/bigquery/docs/reference/standard-sql/date_functions#date
5020class Date(Func):
5021    arg_types = {"this": False, "zone": False, "expressions": False}
5022    is_var_len_args = True
5023
5024
5025class Day(Func):
5026    pass
5027
5028
5029class Decode(Func):
5030    arg_types = {"this": True, "charset": True, "replace": False}
5031
5032
5033class DiToDate(Func):
5034    pass
5035
5036
5037class Encode(Func):
5038    arg_types = {"this": True, "charset": True}
5039
5040
5041class Exp(Func):
5042    pass
5043
5044
5045# https://docs.snowflake.com/en/sql-reference/functions/flatten
5046class Explode(Func):
5047    arg_types = {"this": True, "expressions": False}
5048    is_var_len_args = True
5049
5050
5051class ExplodeOuter(Explode):
5052    pass
5053
5054
5055class Posexplode(Explode):
5056    pass
5057
5058
5059class PosexplodeOuter(Posexplode, ExplodeOuter):
5060    pass
5061
5062
5063class Floor(Func):
5064    arg_types = {"this": True, "decimals": False}
5065
5066
5067class FromBase64(Func):
5068    pass
5069
5070
5071class ToBase64(Func):
5072    pass
5073
5074
5075class GenerateDateArray(Func):
5076    arg_types = {"start": True, "end": True, "interval": False}
5077
5078
5079class Greatest(Func):
5080    arg_types = {"this": True, "expressions": False}
5081    is_var_len_args = True
5082
5083
5084class GroupConcat(AggFunc):
5085    arg_types = {"this": True, "separator": False}
5086
5087
5088class Hex(Func):
5089    pass
5090
5091
5092class Xor(Connector, Func):
5093    arg_types = {"this": False, "expression": False, "expressions": False}
5094
5095
5096class If(Func):
5097    arg_types = {"this": True, "true": True, "false": False}
5098    _sql_names = ["IF", "IIF"]
5099
5100
5101class Nullif(Func):
5102    arg_types = {"this": True, "expression": True}
5103
5104
5105class Initcap(Func):
5106    arg_types = {"this": True, "expression": False}
5107
5108
5109class IsNan(Func):
5110    _sql_names = ["IS_NAN", "ISNAN"]
5111
5112
5113class IsInf(Func):
5114    _sql_names = ["IS_INF", "ISINF"]
5115
5116
5117class JSONPath(Expression):
5118    arg_types = {"expressions": True}
5119
5120    @property
5121    def output_name(self) -> str:
5122        last_segment = self.expressions[-1].this
5123        return last_segment if isinstance(last_segment, str) else ""
5124
5125
5126class JSONPathPart(Expression):
5127    arg_types = {}
5128
5129
5130class JSONPathFilter(JSONPathPart):
5131    arg_types = {"this": True}
5132
5133
5134class JSONPathKey(JSONPathPart):
5135    arg_types = {"this": True}
5136
5137
5138class JSONPathRecursive(JSONPathPart):
5139    arg_types = {"this": False}
5140
5141
5142class JSONPathRoot(JSONPathPart):
5143    pass
5144
5145
5146class JSONPathScript(JSONPathPart):
5147    arg_types = {"this": True}
5148
5149
5150class JSONPathSlice(JSONPathPart):
5151    arg_types = {"start": False, "end": False, "step": False}
5152
5153
5154class JSONPathSelector(JSONPathPart):
5155    arg_types = {"this": True}
5156
5157
5158class JSONPathSubscript(JSONPathPart):
5159    arg_types = {"this": True}
5160
5161
5162class JSONPathUnion(JSONPathPart):
5163    arg_types = {"expressions": True}
5164
5165
5166class JSONPathWildcard(JSONPathPart):
5167    pass
5168
5169
5170class FormatJson(Expression):
5171    pass
5172
5173
5174class JSONKeyValue(Expression):
5175    arg_types = {"this": True, "expression": True}
5176
5177
5178class JSONObject(Func):
5179    arg_types = {
5180        "expressions": False,
5181        "null_handling": False,
5182        "unique_keys": False,
5183        "return_type": False,
5184        "encoding": False,
5185    }
5186
5187
5188class JSONObjectAgg(AggFunc):
5189    arg_types = {
5190        "expressions": False,
5191        "null_handling": False,
5192        "unique_keys": False,
5193        "return_type": False,
5194        "encoding": False,
5195    }
5196
5197
5198# https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/JSON_ARRAY.html
5199class JSONArray(Func):
5200    arg_types = {
5201        "expressions": True,
5202        "null_handling": False,
5203        "return_type": False,
5204        "strict": False,
5205    }
5206
5207
5208# https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/JSON_ARRAYAGG.html
5209class JSONArrayAgg(Func):
5210    arg_types = {
5211        "this": True,
5212        "order": False,
5213        "null_handling": False,
5214        "return_type": False,
5215        "strict": False,
5216    }
5217
5218
5219# https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/JSON_TABLE.html
5220# Note: parsing of JSON column definitions is currently incomplete.
5221class JSONColumnDef(Expression):
5222    arg_types = {"this": False, "kind": False, "path": False, "nested_schema": False}
5223
5224
5225class JSONSchema(Expression):
5226    arg_types = {"expressions": True}
5227
5228
5229# # https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/JSON_TABLE.html
5230class JSONTable(Func):
5231    arg_types = {
5232        "this": True,
5233        "schema": True,
5234        "path": False,
5235        "error_handling": False,
5236        "empty_handling": False,
5237    }
5238
5239
5240class OpenJSONColumnDef(Expression):
5241    arg_types = {"this": True, "kind": True, "path": False, "as_json": False}
5242
5243
5244class OpenJSON(Func):
5245    arg_types = {"this": True, "path": False, "expressions": False}
5246
5247
5248class JSONBContains(Binary):
5249    _sql_names = ["JSONB_CONTAINS"]
5250
5251
5252class JSONExtract(Binary, Func):
5253    arg_types = {"this": True, "expression": True, "only_json_types": False, "expressions": False}
5254    _sql_names = ["JSON_EXTRACT"]
5255    is_var_len_args = True
5256
5257    @property
5258    def output_name(self) -> str:
5259        return self.expression.output_name if not self.expressions else ""
5260
5261
5262class JSONExtractScalar(Binary, Func):
5263    arg_types = {"this": True, "expression": True, "only_json_types": False, "expressions": False}
5264    _sql_names = ["JSON_EXTRACT_SCALAR"]
5265    is_var_len_args = True
5266
5267    @property
5268    def output_name(self) -> str:
5269        return self.expression.output_name
5270
5271
5272class JSONBExtract(Binary, Func):
5273    _sql_names = ["JSONB_EXTRACT"]
5274
5275
5276class JSONBExtractScalar(Binary, Func):
5277    _sql_names = ["JSONB_EXTRACT_SCALAR"]
5278
5279
5280class JSONFormat(Func):
5281    arg_types = {"this": False, "options": False}
5282    _sql_names = ["JSON_FORMAT"]
5283
5284
5285# https://dev.mysql.com/doc/refman/8.0/en/json-search-functions.html#operator_member-of
5286class JSONArrayContains(Binary, Predicate, Func):
5287    _sql_names = ["JSON_ARRAY_CONTAINS"]
5288
5289
5290class ParseJSON(Func):
5291    # BigQuery, Snowflake have PARSE_JSON, Presto has JSON_PARSE
5292    _sql_names = ["PARSE_JSON", "JSON_PARSE"]
5293    arg_types = {"this": True, "expressions": False}
5294    is_var_len_args = True
5295
5296
5297class Least(Func):
5298    arg_types = {"this": True, "expressions": False}
5299    is_var_len_args = True
5300
5301
5302class Left(Func):
5303    arg_types = {"this": True, "expression": True}
5304
5305
5306class Right(Func):
5307    arg_types = {"this": True, "expression": True}
5308
5309
5310class Length(Func):
5311    _sql_names = ["LENGTH", "LEN"]
5312
5313
5314class Levenshtein(Func):
5315    arg_types = {
5316        "this": True,
5317        "expression": False,
5318        "ins_cost": False,
5319        "del_cost": False,
5320        "sub_cost": False,
5321    }
5322
5323
5324class Ln(Func):
5325    pass
5326
5327
5328class Log(Func):
5329    arg_types = {"this": True, "expression": False}
5330
5331
5332class LogicalOr(AggFunc):
5333    _sql_names = ["LOGICAL_OR", "BOOL_OR", "BOOLOR_AGG"]
5334
5335
5336class LogicalAnd(AggFunc):
5337    _sql_names = ["LOGICAL_AND", "BOOL_AND", "BOOLAND_AGG"]
5338
5339
5340class Lower(Func):
5341    _sql_names = ["LOWER", "LCASE"]
5342
5343
5344class Map(Func):
5345    arg_types = {"keys": False, "values": False}
5346
5347    @property
5348    def keys(self) -> t.List[Expression]:
5349        keys = self.args.get("keys")
5350        return keys.expressions if keys else []
5351
5352    @property
5353    def values(self) -> t.List[Expression]:
5354        values = self.args.get("values")
5355        return values.expressions if values else []
5356
5357
5358# Represents the MAP {...} syntax in DuckDB - basically convert a struct to a MAP
5359class ToMap(Func):
5360    pass
5361
5362
5363class MapFromEntries(Func):
5364    pass
5365
5366
5367class StarMap(Func):
5368    pass
5369
5370
5371class VarMap(Func):
5372    arg_types = {"keys": True, "values": True}
5373    is_var_len_args = True
5374
5375    @property
5376    def keys(self) -> t.List[Expression]:
5377        return self.args["keys"].expressions
5378
5379    @property
5380    def values(self) -> t.List[Expression]:
5381        return self.args["values"].expressions
5382
5383
5384# https://dev.mysql.com/doc/refman/8.0/en/fulltext-search.html
5385class MatchAgainst(Func):
5386    arg_types = {"this": True, "expressions": True, "modifier": False}
5387
5388
5389class Max(AggFunc):
5390    arg_types = {"this": True, "expressions": False}
5391    is_var_len_args = True
5392
5393
5394class MD5(Func):
5395    _sql_names = ["MD5"]
5396
5397
5398# Represents the variant of the MD5 function that returns a binary value
5399class MD5Digest(Func):
5400    _sql_names = ["MD5_DIGEST"]
5401
5402
5403class Min(AggFunc):
5404    arg_types = {"this": True, "expressions": False}
5405    is_var_len_args = True
5406
5407
5408class Month(Func):
5409    pass
5410
5411
5412class AddMonths(Func):
5413    arg_types = {"this": True, "expression": True}
5414
5415
5416class Nvl2(Func):
5417    arg_types = {"this": True, "true": True, "false": False}
5418
5419
5420# https://cloud.google.com/bigquery/docs/reference/standard-sql/bigqueryml-syntax-predict#mlpredict_function
5421class Predict(Func):
5422    arg_types = {"this": True, "expression": True, "params_struct": False}
5423
5424
5425class Pow(Binary, Func):
5426    _sql_names = ["POWER", "POW"]
5427
5428
5429class PercentileCont(AggFunc):
5430    arg_types = {"this": True, "expression": False}
5431
5432
5433class PercentileDisc(AggFunc):
5434    arg_types = {"this": True, "expression": False}
5435
5436
5437class Quantile(AggFunc):
5438    arg_types = {"this": True, "quantile": True}
5439
5440
5441class ApproxQuantile(Quantile):
5442    arg_types = {"this": True, "quantile": True, "accuracy": False, "weight": False}
5443
5444
5445class Rand(Func):
5446    _sql_names = ["RAND", "RANDOM"]
5447    arg_types = {"this": False}
5448
5449
5450class Randn(Func):
5451    arg_types = {"this": False}
5452
5453
5454class RangeN(Func):
5455    arg_types = {"this": True, "expressions": True, "each": False}
5456
5457
5458class ReadCSV(Func):
5459    _sql_names = ["READ_CSV"]
5460    is_var_len_args = True
5461    arg_types = {"this": True, "expressions": False}
5462
5463
5464class Reduce(Func):
5465    arg_types = {"this": True, "initial": True, "merge": True, "finish": False}
5466
5467
5468class RegexpExtract(Func):
5469    arg_types = {
5470        "this": True,
5471        "expression": True,
5472        "position": False,
5473        "occurrence": False,
5474        "parameters": False,
5475        "group": False,
5476    }
5477
5478
5479class RegexpReplace(Func):
5480    arg_types = {
5481        "this": True,
5482        "expression": True,
5483        "replacement": False,
5484        "position": False,
5485        "occurrence": False,
5486        "parameters": False,
5487        "modifiers": False,
5488    }
5489
5490
5491class RegexpLike(Binary, Func):
5492    arg_types = {"this": True, "expression": True, "flag": False}
5493
5494
5495class RegexpILike(Binary, Func):
5496    arg_types = {"this": True, "expression": True, "flag": False}
5497
5498
5499# https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.split.html
5500# limit is the number of times a pattern is applied
5501class RegexpSplit(Func):
5502    arg_types = {"this": True, "expression": True, "limit": False}
5503
5504
5505class Repeat(Func):
5506    arg_types = {"this": True, "times": True}
5507
5508
5509# https://learn.microsoft.com/en-us/sql/t-sql/functions/round-transact-sql?view=sql-server-ver16
5510# tsql third argument function == trunctaion if not 0
5511class Round(Func):
5512    arg_types = {"this": True, "decimals": False, "truncate": False}
5513
5514
5515class RowNumber(Func):
5516    arg_types: t.Dict[str, t.Any] = {}
5517
5518
5519class SafeDivide(Func):
5520    arg_types = {"this": True, "expression": True}
5521
5522
5523class SHA(Func):
5524    _sql_names = ["SHA", "SHA1"]
5525
5526
5527class SHA2(Func):
5528    _sql_names = ["SHA2"]
5529    arg_types = {"this": True, "length": False}
5530
5531
5532class Sign(Func):
5533    _sql_names = ["SIGN", "SIGNUM"]
5534
5535
5536class SortArray(Func):
5537    arg_types = {"this": True, "asc": False}
5538
5539
5540class Split(Func):
5541    arg_types = {"this": True, "expression": True, "limit": False}
5542
5543
5544# Start may be omitted in the case of postgres
5545# https://www.postgresql.org/docs/9.1/functions-string.html @ Table 9-6
5546class Substring(Func):
5547    arg_types = {"this": True, "start": False, "length": False}
5548
5549
5550class StandardHash(Func):
5551    arg_types = {"this": True, "expression": False}
5552
5553
5554class StartsWith(Func):
5555    _sql_names = ["STARTS_WITH", "STARTSWITH"]
5556    arg_types = {"this": True, "expression": True}
5557
5558
5559class StrPosition(Func):
5560    arg_types = {
5561        "this": True,
5562        "substr": True,
5563        "position": False,
5564        "instance": False,
5565    }
5566
5567
5568class StrToDate(Func):
5569    arg_types = {"this": True, "format": True}
5570
5571
5572class StrToTime(Func):
5573    arg_types = {"this": True, "format": True, "zone": False}
5574
5575
5576# Spark allows unix_timestamp()
5577# https://spark.apache.org/docs/3.1.3/api/python/reference/api/pyspark.sql.functions.unix_timestamp.html
5578class StrToUnix(Func):
5579    arg_types = {"this": False, "format": False}
5580
5581
5582# https://prestodb.io/docs/current/functions/string.html
5583# https://spark.apache.org/docs/latest/api/sql/index.html#str_to_map
5584class StrToMap(Func):
5585    arg_types = {
5586        "this": True,
5587        "pair_delim": False,
5588        "key_value_delim": False,
5589        "duplicate_resolution_callback": False,
5590    }
5591
5592
5593class NumberToStr(Func):
5594    arg_types = {"this": True, "format": True, "culture": False}
5595
5596
5597class FromBase(Func):
5598    arg_types = {"this": True, "expression": True}
5599
5600
5601class Struct(Func):
5602    arg_types = {"expressions": False}
5603    is_var_len_args = True
5604
5605
5606class StructExtract(Func):
5607    arg_types = {"this": True, "expression": True}
5608
5609
5610# https://learn.microsoft.com/en-us/sql/t-sql/functions/stuff-transact-sql?view=sql-server-ver16
5611# https://docs.snowflake.com/en/sql-reference/functions/insert
5612class Stuff(Func):
5613    _sql_names = ["STUFF", "INSERT"]
5614    arg_types = {"this": True, "start": True, "length": True, "expression": True}
5615
5616
5617class Sum(AggFunc):
5618    pass
5619
5620
5621class Sqrt(Func):
5622    pass
5623
5624
5625class Stddev(AggFunc):
5626    pass
5627
5628
5629class StddevPop(AggFunc):
5630    pass
5631
5632
5633class StddevSamp(AggFunc):
5634    pass
5635
5636
5637class TimeToStr(Func):
5638    arg_types = {"this": True, "format": True, "culture": False}
5639
5640
5641class TimeToTimeStr(Func):
5642    pass
5643
5644
5645class TimeToUnix(Func):
5646    pass
5647
5648
5649class TimeStrToDate(Func):
5650    pass
5651
5652
5653class TimeStrToTime(Func):
5654    pass
5655
5656
5657class TimeStrToUnix(Func):
5658    pass
5659
5660
5661class Trim(Func):
5662    arg_types = {
5663        "this": True,
5664        "expression": False,
5665        "position": False,
5666        "collation": False,
5667    }
5668
5669
5670class TsOrDsAdd(Func, TimeUnit):
5671    # return_type is used to correctly cast the arguments of this expression when transpiling it
5672    arg_types = {"this": True, "expression": True, "unit": False, "return_type": False}
5673
5674    @property
5675    def return_type(self) -> DataType:
5676        return DataType.build(self.args.get("return_type") or DataType.Type.DATE)
5677
5678
5679class TsOrDsDiff(Func, TimeUnit):
5680    arg_types = {"this": True, "expression": True, "unit": False}
5681
5682
5683class TsOrDsToDateStr(Func):
5684    pass
5685
5686
5687class TsOrDsToDate(Func):
5688    arg_types = {"this": True, "format": False, "safe": False}
5689
5690
5691class TsOrDsToTime(Func):
5692    pass
5693
5694
5695class TsOrDsToTimestamp(Func):
5696    pass
5697
5698
5699class TsOrDiToDi(Func):
5700    pass
5701
5702
5703class Unhex(Func):
5704    pass
5705
5706
5707# https://cloud.google.com/bigquery/docs/reference/standard-sql/date_functions#unix_date
5708class UnixDate(Func):
5709    pass
5710
5711
5712class UnixToStr(Func):
5713    arg_types = {"this": True, "format": False}
5714
5715
5716# https://prestodb.io/docs/current/functions/datetime.html
5717# presto has weird zone/hours/minutes
5718class UnixToTime(Func):
5719    arg_types = {
5720        "this": True,
5721        "scale": False,
5722        "zone": False,
5723        "hours": False,
5724        "minutes": False,
5725        "format": False,
5726    }
5727
5728    SECONDS = Literal.number(0)
5729    DECIS = Literal.number(1)
5730    CENTIS = Literal.number(2)
5731    MILLIS = Literal.number(3)
5732    DECIMILLIS = Literal.number(4)
5733    CENTIMILLIS = Literal.number(5)
5734    MICROS = Literal.number(6)
5735    DECIMICROS = Literal.number(7)
5736    CENTIMICROS = Literal.number(8)
5737    NANOS = Literal.number(9)
5738
5739
5740class UnixToTimeStr(Func):
5741    pass
5742
5743
5744class TimestampFromParts(Func):
5745    _sql_names = ["TIMESTAMP_FROM_PARTS", "TIMESTAMPFROMPARTS"]
5746    arg_types = {
5747        "year": True,
5748        "month": True,
5749        "day": True,
5750        "hour": True,
5751        "min": True,
5752        "sec": True,
5753        "nano": False,
5754        "zone": False,
5755        "milli": False,
5756    }
5757
5758
5759class Upper(Func):
5760    _sql_names = ["UPPER", "UCASE"]
5761
5762
5763class Corr(Binary, AggFunc):
5764    pass
5765
5766
5767class Variance(AggFunc):
5768    _sql_names = ["VARIANCE", "VARIANCE_SAMP", "VAR_SAMP"]
5769
5770
5771class VariancePop(AggFunc):
5772    _sql_names = ["VARIANCE_POP", "VAR_POP"]
5773
5774
5775class CovarSamp(Binary, AggFunc):
5776    pass
5777
5778
5779class CovarPop(Binary, AggFunc):
5780    pass
5781
5782
5783class Week(Func):
5784    arg_types = {"this": True, "mode": False}
5785
5786
5787class XMLTable(Func):
5788    arg_types = {"this": True, "passing": False, "columns": False, "by_ref": False}
5789
5790
5791class Year(Func):
5792    pass
5793
5794
5795class Use(Expression):
5796    arg_types = {"this": True, "kind": False}
5797
5798
5799class Merge(Expression):
5800    arg_types = {
5801        "this": True,
5802        "using": True,
5803        "on": True,
5804        "expressions": True,
5805        "with": False,
5806    }
5807
5808
5809class When(Func):
5810    arg_types = {"matched": True, "source": False, "condition": False, "then": True}
5811
5812
5813# https://docs.oracle.com/javadb/10.8.3.0/ref/rrefsqljnextvaluefor.html
5814# https://learn.microsoft.com/en-us/sql/t-sql/functions/next-value-for-transact-sql?view=sql-server-ver16
5815class NextValueFor(Func):
5816    arg_types = {"this": True, "order": False}
5817
5818
5819def _norm_arg(arg):
5820    return arg.lower() if type(arg) is str else arg
5821
5822
5823ALL_FUNCTIONS = subclasses(__name__, Func, (AggFunc, Anonymous, Func))
5824FUNCTION_BY_NAME = {name: func for func in ALL_FUNCTIONS for name in func.sql_names()}
5825
5826JSON_PATH_PARTS = subclasses(__name__, JSONPathPart, (JSONPathPart,))
5827
5828
5829# Helpers
5830@t.overload
5831def maybe_parse(
5832    sql_or_expression: ExpOrStr,
5833    *,
5834    into: t.Type[E],
5835    dialect: DialectType = None,
5836    prefix: t.Optional[str] = None,
5837    copy: bool = False,
5838    **opts,
5839) -> E: ...
5840
5841
5842@t.overload
5843def maybe_parse(
5844    sql_or_expression: str | E,
5845    *,
5846    into: t.Optional[IntoType] = None,
5847    dialect: DialectType = None,
5848    prefix: t.Optional[str] = None,
5849    copy: bool = False,
5850    **opts,
5851) -> E: ...
5852
5853
5854def maybe_parse(
5855    sql_or_expression: ExpOrStr,
5856    *,
5857    into: t.Optional[IntoType] = None,
5858    dialect: DialectType = None,
5859    prefix: t.Optional[str] = None,
5860    copy: bool = False,
5861    **opts,
5862) -> Expression:
5863    """Gracefully handle a possible string or expression.
5864
5865    Example:
5866        >>> maybe_parse("1")
5867        Literal(this=1, is_string=False)
5868        >>> maybe_parse(to_identifier("x"))
5869        Identifier(this=x, quoted=False)
5870
5871    Args:
5872        sql_or_expression: the SQL code string or an expression
5873        into: the SQLGlot Expression to parse into
5874        dialect: the dialect used to parse the input expressions (in the case that an
5875            input expression is a SQL string).
5876        prefix: a string to prefix the sql with before it gets parsed
5877            (automatically includes a space)
5878        copy: whether to copy the expression.
5879        **opts: other options to use to parse the input expressions (again, in the case
5880            that an input expression is a SQL string).
5881
5882    Returns:
5883        Expression: the parsed or given expression.
5884    """
5885    if isinstance(sql_or_expression, Expression):
5886        if copy:
5887            return sql_or_expression.copy()
5888        return sql_or_expression
5889
5890    if sql_or_expression is None:
5891        raise ParseError("SQL cannot be None")
5892
5893    import sqlglot
5894
5895    sql = str(sql_or_expression)
5896    if prefix:
5897        sql = f"{prefix} {sql}"
5898
5899    return sqlglot.parse_one(sql, read=dialect, into=into, **opts)
5900
5901
5902@t.overload
5903def maybe_copy(instance: None, copy: bool = True) -> None: ...
5904
5905
5906@t.overload
5907def maybe_copy(instance: E, copy: bool = True) -> E: ...
5908
5909
5910def maybe_copy(instance, copy=True):
5911    return instance.copy() if copy and instance else instance
5912
5913
5914def _to_s(node: t.Any, verbose: bool = False, level: int = 0) -> str:
5915    """Generate a textual representation of an Expression tree"""
5916    indent = "\n" + ("  " * (level + 1))
5917    delim = f",{indent}"
5918
5919    if isinstance(node, Expression):
5920        args = {k: v for k, v in node.args.items() if (v is not None and v != []) or verbose}
5921
5922        if (node.type or verbose) and not isinstance(node, DataType):
5923            args["_type"] = node.type
5924        if node.comments or verbose:
5925            args["_comments"] = node.comments
5926
5927        if verbose:
5928            args["_id"] = id(node)
5929
5930        # Inline leaves for a more compact representation
5931        if node.is_leaf():
5932            indent = ""
5933            delim = ", "
5934
5935        items = delim.join([f"{k}={_to_s(v, verbose, level + 1)}" for k, v in args.items()])
5936        return f"{node.__class__.__name__}({indent}{items})"
5937
5938    if isinstance(node, list):
5939        items = delim.join(_to_s(i, verbose, level + 1) for i in node)
5940        items = f"{indent}{items}" if items else ""
5941        return f"[{items}]"
5942
5943    # Indent multiline strings to match the current level
5944    return indent.join(textwrap.dedent(str(node).strip("\n")).splitlines())
5945
5946
5947def _is_wrong_expression(expression, into):
5948    return isinstance(expression, Expression) and not isinstance(expression, into)
5949
5950
5951def _apply_builder(
5952    expression,
5953    instance,
5954    arg,
5955    copy=True,
5956    prefix=None,
5957    into=None,
5958    dialect=None,
5959    into_arg="this",
5960    **opts,
5961):
5962    if _is_wrong_expression(expression, into):
5963        expression = into(**{into_arg: expression})
5964    instance = maybe_copy(instance, copy)
5965    expression = maybe_parse(
5966        sql_or_expression=expression,
5967        prefix=prefix,
5968        into=into,
5969        dialect=dialect,
5970        **opts,
5971    )
5972    instance.set(arg, expression)
5973    return instance
5974
5975
5976def _apply_child_list_builder(
5977    *expressions,
5978    instance,
5979    arg,
5980    append=True,
5981    copy=True,
5982    prefix=None,
5983    into=None,
5984    dialect=None,
5985    properties=None,
5986    **opts,
5987):
5988    instance = maybe_copy(instance, copy)
5989    parsed = []
5990    for expression in expressions:
5991        if expression is not None:
5992            if _is_wrong_expression(expression, into):
5993                expression = into(expressions=[expression])
5994
5995            expression = maybe_parse(
5996                expression,
5997                into=into,
5998                dialect=dialect,
5999                prefix=prefix,
6000                **opts,
6001            )
6002            parsed.extend(expression.expressions)
6003
6004    existing = instance.args.get(arg)
6005    if append and existing:
6006        parsed = existing.expressions + parsed
6007
6008    child = into(expressions=parsed)
6009    for k, v in (properties or {}).items():
6010        child.set(k, v)
6011    instance.set(arg, child)
6012
6013    return instance
6014
6015
6016def _apply_list_builder(
6017    *expressions,
6018    instance,
6019    arg,
6020    append=True,
6021    copy=True,
6022    prefix=None,
6023    into=None,
6024    dialect=None,
6025    **opts,
6026):
6027    inst = maybe_copy(instance, copy)
6028
6029    expressions = [
6030        maybe_parse(
6031            sql_or_expression=expression,
6032            into=into,
6033            prefix=prefix,
6034            dialect=dialect,
6035            **opts,
6036        )
6037        for expression in expressions
6038        if expression is not None
6039    ]
6040
6041    existing_expressions = inst.args.get(arg)
6042    if append and existing_expressions:
6043        expressions = existing_expressions + expressions
6044
6045    inst.set(arg, expressions)
6046    return inst
6047
6048
6049def _apply_conjunction_builder(
6050    *expressions,
6051    instance,
6052    arg,
6053    into=None,
6054    append=True,
6055    copy=True,
6056    dialect=None,
6057    **opts,
6058):
6059    expressions = [exp for exp in expressions if exp is not None and exp != ""]
6060    if not expressions:
6061        return instance
6062
6063    inst = maybe_copy(instance, copy)
6064
6065    existing = inst.args.get(arg)
6066    if append and existing is not None:
6067        expressions = [existing.this if into else existing] + list(expressions)
6068
6069    node = and_(*expressions, dialect=dialect, copy=copy, **opts)
6070
6071    inst.set(arg, into(this=node) if into else node)
6072    return inst
6073
6074
6075def _apply_cte_builder(
6076    instance: E,
6077    alias: ExpOrStr,
6078    as_: ExpOrStr,
6079    recursive: t.Optional[bool] = None,
6080    append: bool = True,
6081    dialect: DialectType = None,
6082    copy: bool = True,
6083    **opts,
6084) -> E:
6085    alias_expression = maybe_parse(alias, dialect=dialect, into=TableAlias, **opts)
6086    as_expression = maybe_parse(as_, dialect=dialect, **opts)
6087    cte = CTE(this=as_expression, alias=alias_expression)
6088    return _apply_child_list_builder(
6089        cte,
6090        instance=instance,
6091        arg="with",
6092        append=append,
6093        copy=copy,
6094        into=With,
6095        properties={"recursive": recursive or False},
6096    )
6097
6098
6099def _combine(
6100    expressions: t.Sequence[t.Optional[ExpOrStr]],
6101    operator: t.Type[Connector],
6102    dialect: DialectType = None,
6103    copy: bool = True,
6104    **opts,
6105) -> Expression:
6106    conditions = [
6107        condition(expression, dialect=dialect, copy=copy, **opts)
6108        for expression in expressions
6109        if expression is not None
6110    ]
6111
6112    this, *rest = conditions
6113    if rest:
6114        this = _wrap(this, Connector)
6115    for expression in rest:
6116        this = operator(this=this, expression=_wrap(expression, Connector))
6117
6118    return this
6119
6120
6121def _wrap(expression: E, kind: t.Type[Expression]) -> E | Paren:
6122    return Paren(this=expression) if isinstance(expression, kind) else expression
6123
6124
6125def union(
6126    left: ExpOrStr,
6127    right: ExpOrStr,
6128    distinct: bool = True,
6129    dialect: DialectType = None,
6130    copy: bool = True,
6131    **opts,
6132) -> Union:
6133    """
6134    Initializes a syntax tree from one UNION expression.
6135
6136    Example:
6137        >>> union("SELECT * FROM foo", "SELECT * FROM bla").sql()
6138        'SELECT * FROM foo UNION SELECT * FROM bla'
6139
6140    Args:
6141        left: the SQL code string corresponding to the left-hand side.
6142            If an `Expression` instance is passed, it will be used as-is.
6143        right: the SQL code string corresponding to the right-hand side.
6144            If an `Expression` instance is passed, it will be used as-is.
6145        distinct: set the DISTINCT flag if and only if this is true.
6146        dialect: the dialect used to parse the input expression.
6147        copy: whether to copy the expression.
6148        opts: other options to use to parse the input expressions.
6149
6150    Returns:
6151        The new Union instance.
6152    """
6153    left = maybe_parse(sql_or_expression=left, dialect=dialect, copy=copy, **opts)
6154    right = maybe_parse(sql_or_expression=right, dialect=dialect, copy=copy, **opts)
6155
6156    return Union(this=left, expression=right, distinct=distinct)
6157
6158
6159def intersect(
6160    left: ExpOrStr,
6161    right: ExpOrStr,
6162    distinct: bool = True,
6163    dialect: DialectType = None,
6164    copy: bool = True,
6165    **opts,
6166) -> Intersect:
6167    """
6168    Initializes a syntax tree from one INTERSECT expression.
6169
6170    Example:
6171        >>> intersect("SELECT * FROM foo", "SELECT * FROM bla").sql()
6172        'SELECT * FROM foo INTERSECT SELECT * FROM bla'
6173
6174    Args:
6175        left: the SQL code string corresponding to the left-hand side.
6176            If an `Expression` instance is passed, it will be used as-is.
6177        right: the SQL code string corresponding to the right-hand side.
6178            If an `Expression` instance is passed, it will be used as-is.
6179        distinct: set the DISTINCT flag if and only if this is true.
6180        dialect: the dialect used to parse the input expression.
6181        copy: whether to copy the expression.
6182        opts: other options to use to parse the input expressions.
6183
6184    Returns:
6185        The new Intersect instance.
6186    """
6187    left = maybe_parse(sql_or_expression=left, dialect=dialect, copy=copy, **opts)
6188    right = maybe_parse(sql_or_expression=right, dialect=dialect, copy=copy, **opts)
6189
6190    return Intersect(this=left, expression=right, distinct=distinct)
6191
6192
6193def except_(
6194    left: ExpOrStr,
6195    right: ExpOrStr,
6196    distinct: bool = True,
6197    dialect: DialectType = None,
6198    copy: bool = True,
6199    **opts,
6200) -> Except:
6201    """
6202    Initializes a syntax tree from one EXCEPT expression.
6203
6204    Example:
6205        >>> except_("SELECT * FROM foo", "SELECT * FROM bla").sql()
6206        'SELECT * FROM foo EXCEPT SELECT * FROM bla'
6207
6208    Args:
6209        left: the SQL code string corresponding to the left-hand side.
6210            If an `Expression` instance is passed, it will be used as-is.
6211        right: the SQL code string corresponding to the right-hand side.
6212            If an `Expression` instance is passed, it will be used as-is.
6213        distinct: set the DISTINCT flag if and only if this is true.
6214        dialect: the dialect used to parse the input expression.
6215        copy: whether to copy the expression.
6216        opts: other options to use to parse the input expressions.
6217
6218    Returns:
6219        The new Except instance.
6220    """
6221    left = maybe_parse(sql_or_expression=left, dialect=dialect, copy=copy, **opts)
6222    right = maybe_parse(sql_or_expression=right, dialect=dialect, copy=copy, **opts)
6223
6224    return Except(this=left, expression=right, distinct=distinct)
6225
6226
6227def select(*expressions: ExpOrStr, dialect: DialectType = None, **opts) -> Select:
6228    """
6229    Initializes a syntax tree from one or multiple SELECT expressions.
6230
6231    Example:
6232        >>> select("col1", "col2").from_("tbl").sql()
6233        'SELECT col1, col2 FROM tbl'
6234
6235    Args:
6236        *expressions: the SQL code string to parse as the expressions of a
6237            SELECT statement. If an Expression instance is passed, this is used as-is.
6238        dialect: the dialect used to parse the input expressions (in the case that an
6239            input expression is a SQL string).
6240        **opts: other options to use to parse the input expressions (again, in the case
6241            that an input expression is a SQL string).
6242
6243    Returns:
6244        Select: the syntax tree for the SELECT statement.
6245    """
6246    return Select().select(*expressions, dialect=dialect, **opts)
6247
6248
6249def from_(expression: ExpOrStr, dialect: DialectType = None, **opts) -> Select:
6250    """
6251    Initializes a syntax tree from a FROM expression.
6252
6253    Example:
6254        >>> from_("tbl").select("col1", "col2").sql()
6255        'SELECT col1, col2 FROM tbl'
6256
6257    Args:
6258        *expression: the SQL code string to parse as the FROM expressions of a
6259            SELECT statement. If an Expression instance is passed, this is used as-is.
6260        dialect: the dialect used to parse the input expression (in the case that the
6261            input expression is a SQL string).
6262        **opts: other options to use to parse the input expressions (again, in the case
6263            that the input expression is a SQL string).
6264
6265    Returns:
6266        Select: the syntax tree for the SELECT statement.
6267    """
6268    return Select().from_(expression, dialect=dialect, **opts)
6269
6270
6271def update(
6272    table: str | Table,
6273    properties: dict,
6274    where: t.Optional[ExpOrStr] = None,
6275    from_: t.Optional[ExpOrStr] = None,
6276    dialect: DialectType = None,
6277    **opts,
6278) -> Update:
6279    """
6280    Creates an update statement.
6281
6282    Example:
6283        >>> update("my_table", {"x": 1, "y": "2", "z": None}, from_="baz", where="id > 1").sql()
6284        "UPDATE my_table SET x = 1, y = '2', z = NULL FROM baz WHERE id > 1"
6285
6286    Args:
6287        *properties: dictionary of properties to set which are
6288            auto converted to sql objects eg None -> NULL
6289        where: sql conditional parsed into a WHERE statement
6290        from_: sql statement parsed into a FROM statement
6291        dialect: the dialect used to parse the input expressions.
6292        **opts: other options to use to parse the input expressions.
6293
6294    Returns:
6295        Update: the syntax tree for the UPDATE statement.
6296    """
6297    update_expr = Update(this=maybe_parse(table, into=Table, dialect=dialect))
6298    update_expr.set(
6299        "expressions",
6300        [
6301            EQ(this=maybe_parse(k, dialect=dialect, **opts), expression=convert(v))
6302            for k, v in properties.items()
6303        ],
6304    )
6305    if from_:
6306        update_expr.set(
6307            "from",
6308            maybe_parse(from_, into=From, dialect=dialect, prefix="FROM", **opts),
6309        )
6310    if isinstance(where, Condition):
6311        where = Where(this=where)
6312    if where:
6313        update_expr.set(
6314            "where",
6315            maybe_parse(where, into=Where, dialect=dialect, prefix="WHERE", **opts),
6316        )
6317    return update_expr
6318
6319
6320def delete(
6321    table: ExpOrStr,
6322    where: t.Optional[ExpOrStr] = None,
6323    returning: t.Optional[ExpOrStr] = None,
6324    dialect: DialectType = None,
6325    **opts,
6326) -> Delete:
6327    """
6328    Builds a delete statement.
6329
6330    Example:
6331        >>> delete("my_table", where="id > 1").sql()
6332        'DELETE FROM my_table WHERE id > 1'
6333
6334    Args:
6335        where: sql conditional parsed into a WHERE statement
6336        returning: sql conditional parsed into a RETURNING statement
6337        dialect: the dialect used to parse the input expressions.
6338        **opts: other options to use to parse the input expressions.
6339
6340    Returns:
6341        Delete: the syntax tree for the DELETE statement.
6342    """
6343    delete_expr = Delete().delete(table, dialect=dialect, copy=False, **opts)
6344    if where:
6345        delete_expr = delete_expr.where(where, dialect=dialect, copy=False, **opts)
6346    if returning:
6347        delete_expr = t.cast(
6348            Delete, delete_expr.returning(returning, dialect=dialect, copy=False, **opts)
6349        )
6350    return delete_expr
6351
6352
6353def insert(
6354    expression: ExpOrStr,
6355    into: ExpOrStr,
6356    columns: t.Optional[t.Sequence[str | Identifier]] = None,
6357    overwrite: t.Optional[bool] = None,
6358    returning: t.Optional[ExpOrStr] = None,
6359    dialect: DialectType = None,
6360    copy: bool = True,
6361    **opts,
6362) -> Insert:
6363    """
6364    Builds an INSERT statement.
6365
6366    Example:
6367        >>> insert("VALUES (1, 2, 3)", "tbl").sql()
6368        'INSERT INTO tbl VALUES (1, 2, 3)'
6369
6370    Args:
6371        expression: the sql string or expression of the INSERT statement
6372        into: the tbl to insert data to.
6373        columns: optionally the table's column names.
6374        overwrite: whether to INSERT OVERWRITE or not.
6375        returning: sql conditional parsed into a RETURNING statement
6376        dialect: the dialect used to parse the input expressions.
6377        copy: whether to copy the expression.
6378        **opts: other options to use to parse the input expressions.
6379
6380    Returns:
6381        Insert: the syntax tree for the INSERT statement.
6382    """
6383    expr = maybe_parse(expression, dialect=dialect, copy=copy, **opts)
6384    this: Table | Schema = maybe_parse(into, into=Table, dialect=dialect, copy=copy, **opts)
6385
6386    if columns:
6387        this = Schema(this=this, expressions=[to_identifier(c, copy=copy) for c in columns])
6388
6389    insert = Insert(this=this, expression=expr, overwrite=overwrite)
6390
6391    if returning:
6392        insert = t.cast(Insert, insert.returning(returning, dialect=dialect, copy=False, **opts))
6393
6394    return insert
6395
6396
6397def condition(
6398    expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts
6399) -> Condition:
6400    """
6401    Initialize a logical condition expression.
6402
6403    Example:
6404        >>> condition("x=1").sql()
6405        'x = 1'
6406
6407        This is helpful for composing larger logical syntax trees:
6408        >>> where = condition("x=1")
6409        >>> where = where.and_("y=1")
6410        >>> Select().from_("tbl").select("*").where(where).sql()
6411        'SELECT * FROM tbl WHERE x = 1 AND y = 1'
6412
6413    Args:
6414        *expression: the SQL code string to parse.
6415            If an Expression instance is passed, this is used as-is.
6416        dialect: the dialect used to parse the input expression (in the case that the
6417            input expression is a SQL string).
6418        copy: Whether to copy `expression` (only applies to expressions).
6419        **opts: other options to use to parse the input expressions (again, in the case
6420            that the input expression is a SQL string).
6421
6422    Returns:
6423        The new Condition instance
6424    """
6425    return maybe_parse(
6426        expression,
6427        into=Condition,
6428        dialect=dialect,
6429        copy=copy,
6430        **opts,
6431    )
6432
6433
6434def and_(
6435    *expressions: t.Optional[ExpOrStr], dialect: DialectType = None, copy: bool = True, **opts
6436) -> Condition:
6437    """
6438    Combine multiple conditions with an AND logical operator.
6439
6440    Example:
6441        >>> and_("x=1", and_("y=1", "z=1")).sql()
6442        'x = 1 AND (y = 1 AND z = 1)'
6443
6444    Args:
6445        *expressions: the SQL code strings to parse.
6446            If an Expression instance is passed, this is used as-is.
6447        dialect: the dialect used to parse the input expression.
6448        copy: whether to copy `expressions` (only applies to Expressions).
6449        **opts: other options to use to parse the input expressions.
6450
6451    Returns:
6452        And: the new condition
6453    """
6454    return t.cast(Condition, _combine(expressions, And, dialect, copy=copy, **opts))
6455
6456
6457def or_(
6458    *expressions: t.Optional[ExpOrStr], dialect: DialectType = None, copy: bool = True, **opts
6459) -> Condition:
6460    """
6461    Combine multiple conditions with an OR logical operator.
6462
6463    Example:
6464        >>> or_("x=1", or_("y=1", "z=1")).sql()
6465        'x = 1 OR (y = 1 OR z = 1)'
6466
6467    Args:
6468        *expressions: the SQL code strings to parse.
6469            If an Expression instance is passed, this is used as-is.
6470        dialect: the dialect used to parse the input expression.
6471        copy: whether to copy `expressions` (only applies to Expressions).
6472        **opts: other options to use to parse the input expressions.
6473
6474    Returns:
6475        Or: the new condition
6476    """
6477    return t.cast(Condition, _combine(expressions, Or, dialect, copy=copy, **opts))
6478
6479
6480def not_(expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts) -> Not:
6481    """
6482    Wrap a condition with a NOT operator.
6483
6484    Example:
6485        >>> not_("this_suit='black'").sql()
6486        "NOT this_suit = 'black'"
6487
6488    Args:
6489        expression: the SQL code string to parse.
6490            If an Expression instance is passed, this is used as-is.
6491        dialect: the dialect used to parse the input expression.
6492        copy: whether to copy the expression or not.
6493        **opts: other options to use to parse the input expressions.
6494
6495    Returns:
6496        The new condition.
6497    """
6498    this = condition(
6499        expression,
6500        dialect=dialect,
6501        copy=copy,
6502        **opts,
6503    )
6504    return Not(this=_wrap(this, Connector))
6505
6506
6507def paren(expression: ExpOrStr, copy: bool = True) -> Paren:
6508    """
6509    Wrap an expression in parentheses.
6510
6511    Example:
6512        >>> paren("5 + 3").sql()
6513        '(5 + 3)'
6514
6515    Args:
6516        expression: the SQL code string to parse.
6517            If an Expression instance is passed, this is used as-is.
6518        copy: whether to copy the expression or not.
6519
6520    Returns:
6521        The wrapped expression.
6522    """
6523    return Paren(this=maybe_parse(expression, copy=copy))
6524
6525
6526SAFE_IDENTIFIER_RE: t.Pattern[str] = re.compile(r"^[_a-zA-Z][\w]*$")
6527
6528
6529@t.overload
6530def to_identifier(name: None, quoted: t.Optional[bool] = None, copy: bool = True) -> None: ...
6531
6532
6533@t.overload
6534def to_identifier(
6535    name: str | Identifier, quoted: t.Optional[bool] = None, copy: bool = True
6536) -> Identifier: ...
6537
6538
6539def to_identifier(name, quoted=None, copy=True):
6540    """Builds an identifier.
6541
6542    Args:
6543        name: The name to turn into an identifier.
6544        quoted: Whether to force quote the identifier.
6545        copy: Whether to copy name if it's an Identifier.
6546
6547    Returns:
6548        The identifier ast node.
6549    """
6550
6551    if name is None:
6552        return None
6553
6554    if isinstance(name, Identifier):
6555        identifier = maybe_copy(name, copy)
6556    elif isinstance(name, str):
6557        identifier = Identifier(
6558            this=name,
6559            quoted=not SAFE_IDENTIFIER_RE.match(name) if quoted is None else quoted,
6560        )
6561    else:
6562        raise ValueError(f"Name needs to be a string or an Identifier, got: {name.__class__}")
6563    return identifier
6564
6565
6566def parse_identifier(name: str | Identifier, dialect: DialectType = None) -> Identifier:
6567    """
6568    Parses a given string into an identifier.
6569
6570    Args:
6571        name: The name to parse into an identifier.
6572        dialect: The dialect to parse against.
6573
6574    Returns:
6575        The identifier ast node.
6576    """
6577    try:
6578        expression = maybe_parse(name, dialect=dialect, into=Identifier)
6579    except ParseError:
6580        expression = to_identifier(name)
6581
6582    return expression
6583
6584
6585INTERVAL_STRING_RE = re.compile(r"\s*([0-9]+)\s*([a-zA-Z]+)\s*")
6586
6587
6588def to_interval(interval: str | Literal) -> Interval:
6589    """Builds an interval expression from a string like '1 day' or '5 months'."""
6590    if isinstance(interval, Literal):
6591        if not interval.is_string:
6592            raise ValueError("Invalid interval string.")
6593
6594        interval = interval.this
6595
6596    interval_parts = INTERVAL_STRING_RE.match(interval)  # type: ignore
6597
6598    if not interval_parts:
6599        raise ValueError("Invalid interval string.")
6600
6601    return Interval(
6602        this=Literal.string(interval_parts.group(1)),
6603        unit=Var(this=interval_parts.group(2).upper()),
6604    )
6605
6606
6607@t.overload
6608def to_table(sql_path: str | Table, **kwargs) -> Table: ...
6609
6610
6611@t.overload
6612def to_table(sql_path: None, **kwargs) -> None: ...
6613
6614
6615def to_table(
6616    sql_path: t.Optional[str | Table], dialect: DialectType = None, copy: bool = True, **kwargs
6617) -> t.Optional[Table]:
6618    """
6619    Create a table expression from a `[catalog].[schema].[table]` sql path. Catalog and schema are optional.
6620    If a table is passed in then that table is returned.
6621
6622    Args:
6623        sql_path: a `[catalog].[schema].[table]` string.
6624        dialect: the source dialect according to which the table name will be parsed.
6625        copy: Whether to copy a table if it is passed in.
6626        kwargs: the kwargs to instantiate the resulting `Table` expression with.
6627
6628    Returns:
6629        A table expression.
6630    """
6631    if sql_path is None or isinstance(sql_path, Table):
6632        return maybe_copy(sql_path, copy=copy)
6633    if not isinstance(sql_path, str):
6634        raise ValueError(f"Invalid type provided for a table: {type(sql_path)}")
6635
6636    table = maybe_parse(sql_path, into=Table, dialect=dialect)
6637    if table:
6638        for k, v in kwargs.items():
6639            table.set(k, v)
6640
6641    return table
6642
6643
6644def to_column(sql_path: str | Column, **kwargs) -> Column:
6645    """
6646    Create a column from a `[table].[column]` sql path. Schema is optional.
6647
6648    If a column is passed in then that column is returned.
6649
6650    Args:
6651        sql_path: `[table].[column]` string
6652    Returns:
6653        Table: A column expression
6654    """
6655    if sql_path is None or isinstance(sql_path, Column):
6656        return sql_path
6657    if not isinstance(sql_path, str):
6658        raise ValueError(f"Invalid type provided for column: {type(sql_path)}")
6659    return column(*reversed(sql_path.split(".")), **kwargs)  # type: ignore
6660
6661
6662def alias_(
6663    expression: ExpOrStr,
6664    alias: t.Optional[str | Identifier],
6665    table: bool | t.Sequence[str | Identifier] = False,
6666    quoted: t.Optional[bool] = None,
6667    dialect: DialectType = None,
6668    copy: bool = True,
6669    **opts,
6670):
6671    """Create an Alias expression.
6672
6673    Example:
6674        >>> alias_('foo', 'bar').sql()
6675        'foo AS bar'
6676
6677        >>> alias_('(select 1, 2)', 'bar', table=['a', 'b']).sql()
6678        '(SELECT 1, 2) AS bar(a, b)'
6679
6680    Args:
6681        expression: the SQL code strings to parse.
6682            If an Expression instance is passed, this is used as-is.
6683        alias: the alias name to use. If the name has
6684            special characters it is quoted.
6685        table: Whether to create a table alias, can also be a list of columns.
6686        quoted: whether to quote the alias
6687        dialect: the dialect used to parse the input expression.
6688        copy: Whether to copy the expression.
6689        **opts: other options to use to parse the input expressions.
6690
6691    Returns:
6692        Alias: the aliased expression
6693    """
6694    exp = maybe_parse(expression, dialect=dialect, copy=copy, **opts)
6695    alias = to_identifier(alias, quoted=quoted)
6696
6697    if table:
6698        table_alias = TableAlias(this=alias)
6699        exp.set("alias", table_alias)
6700
6701        if not isinstance(table, bool):
6702            for column in table:
6703                table_alias.append("columns", to_identifier(column, quoted=quoted))
6704
6705        return exp
6706
6707    # We don't set the "alias" arg for Window expressions, because that would add an IDENTIFIER node in
6708    # the AST, representing a "named_window" [1] construct (eg. bigquery). What we want is an ALIAS node
6709    # for the complete Window expression.
6710    #
6711    # [1]: https://cloud.google.com/bigquery/docs/reference/standard-sql/window-function-calls
6712
6713    if "alias" in exp.arg_types and not isinstance(exp, Window):
6714        exp.set("alias", alias)
6715        return exp
6716    return Alias(this=exp, alias=alias)
6717
6718
6719def subquery(
6720    expression: ExpOrStr,
6721    alias: t.Optional[Identifier | str] = None,
6722    dialect: DialectType = None,
6723    **opts,
6724) -> Select:
6725    """
6726    Build a subquery expression that's selected from.
6727
6728    Example:
6729        >>> subquery('select x from tbl', 'bar').select('x').sql()
6730        'SELECT x FROM (SELECT x FROM tbl) AS bar'
6731
6732    Args:
6733        expression: the SQL code strings to parse.
6734            If an Expression instance is passed, this is used as-is.
6735        alias: the alias name to use.
6736        dialect: the dialect used to parse the input expression.
6737        **opts: other options to use to parse the input expressions.
6738
6739    Returns:
6740        A new Select instance with the subquery expression included.
6741    """
6742
6743    expression = maybe_parse(expression, dialect=dialect, **opts).subquery(alias)
6744    return Select().from_(expression, dialect=dialect, **opts)
6745
6746
6747@t.overload
6748def column(
6749    col: str | Identifier,
6750    table: t.Optional[str | Identifier] = None,
6751    db: t.Optional[str | Identifier] = None,
6752    catalog: t.Optional[str | Identifier] = None,
6753    *,
6754    fields: t.Collection[t.Union[str, Identifier]],
6755    quoted: t.Optional[bool] = None,
6756    copy: bool = True,
6757) -> Dot:
6758    pass
6759
6760
6761@t.overload
6762def column(
6763    col: str | Identifier,
6764    table: t.Optional[str | Identifier] = None,
6765    db: t.Optional[str | Identifier] = None,
6766    catalog: t.Optional[str | Identifier] = None,
6767    *,
6768    fields: Lit[None] = None,
6769    quoted: t.Optional[bool] = None,
6770    copy: bool = True,
6771) -> Column:
6772    pass
6773
6774
6775def column(
6776    col,
6777    table=None,
6778    db=None,
6779    catalog=None,
6780    *,
6781    fields=None,
6782    quoted=None,
6783    copy=True,
6784):
6785    """
6786    Build a Column.
6787
6788    Args:
6789        col: Column name.
6790        table: Table name.
6791        db: Database name.
6792        catalog: Catalog name.
6793        fields: Additional fields using dots.
6794        quoted: Whether to force quotes on the column's identifiers.
6795        copy: Whether to copy identifiers if passed in.
6796
6797    Returns:
6798        The new Column instance.
6799    """
6800    this = Column(
6801        this=to_identifier(col, quoted=quoted, copy=copy),
6802        table=to_identifier(table, quoted=quoted, copy=copy),
6803        db=to_identifier(db, quoted=quoted, copy=copy),
6804        catalog=to_identifier(catalog, quoted=quoted, copy=copy),
6805    )
6806
6807    if fields:
6808        this = Dot.build((this, *(to_identifier(field, copy=copy) for field in fields)))
6809    return this
6810
6811
6812def cast(expression: ExpOrStr, to: DATA_TYPE, copy: bool = True, **opts) -> Cast:
6813    """Cast an expression to a data type.
6814
6815    Example:
6816        >>> cast('x + 1', 'int').sql()
6817        'CAST(x + 1 AS INT)'
6818
6819    Args:
6820        expression: The expression to cast.
6821        to: The datatype to cast to.
6822        copy: Whether to copy the supplied expressions.
6823
6824    Returns:
6825        The new Cast instance.
6826    """
6827    expression = maybe_parse(expression, copy=copy, **opts)
6828    data_type = DataType.build(to, copy=copy, **opts)
6829    expression = Cast(this=expression, to=data_type)
6830    expression.type = data_type
6831    return expression
6832
6833
6834def table_(
6835    table: Identifier | str,
6836    db: t.Optional[Identifier | str] = None,
6837    catalog: t.Optional[Identifier | str] = None,
6838    quoted: t.Optional[bool] = None,
6839    alias: t.Optional[Identifier | str] = None,
6840) -> Table:
6841    """Build a Table.
6842
6843    Args:
6844        table: Table name.
6845        db: Database name.
6846        catalog: Catalog name.
6847        quote: Whether to force quotes on the table's identifiers.
6848        alias: Table's alias.
6849
6850    Returns:
6851        The new Table instance.
6852    """
6853    return Table(
6854        this=to_identifier(table, quoted=quoted) if table else None,
6855        db=to_identifier(db, quoted=quoted) if db else None,
6856        catalog=to_identifier(catalog, quoted=quoted) if catalog else None,
6857        alias=TableAlias(this=to_identifier(alias)) if alias else None,
6858    )
6859
6860
6861def values(
6862    values: t.Iterable[t.Tuple[t.Any, ...]],
6863    alias: t.Optional[str] = None,
6864    columns: t.Optional[t.Iterable[str] | t.Dict[str, DataType]] = None,
6865) -> Values:
6866    """Build VALUES statement.
6867
6868    Example:
6869        >>> values([(1, '2')]).sql()
6870        "VALUES (1, '2')"
6871
6872    Args:
6873        values: values statements that will be converted to SQL
6874        alias: optional alias
6875        columns: Optional list of ordered column names or ordered dictionary of column names to types.
6876         If either are provided then an alias is also required.
6877
6878    Returns:
6879        Values: the Values expression object
6880    """
6881    if columns and not alias:
6882        raise ValueError("Alias is required when providing columns")
6883
6884    return Values(
6885        expressions=[convert(tup) for tup in values],
6886        alias=(
6887            TableAlias(this=to_identifier(alias), columns=[to_identifier(x) for x in columns])
6888            if columns
6889            else (TableAlias(this=to_identifier(alias)) if alias else None)
6890        ),
6891    )
6892
6893
6894def var(name: t.Optional[ExpOrStr]) -> Var:
6895    """Build a SQL variable.
6896
6897    Example:
6898        >>> repr(var('x'))
6899        'Var(this=x)'
6900
6901        >>> repr(var(column('x', table='y')))
6902        'Var(this=x)'
6903
6904    Args:
6905        name: The name of the var or an expression who's name will become the var.
6906
6907    Returns:
6908        The new variable node.
6909    """
6910    if not name:
6911        raise ValueError("Cannot convert empty name into var.")
6912
6913    if isinstance(name, Expression):
6914        name = name.name
6915    return Var(this=name)
6916
6917
6918def rename_table(old_name: str | Table, new_name: str | Table) -> AlterTable:
6919    """Build ALTER TABLE... RENAME... expression
6920
6921    Args:
6922        old_name: The old name of the table
6923        new_name: The new name of the table
6924
6925    Returns:
6926        Alter table expression
6927    """
6928    old_table = to_table(old_name)
6929    new_table = to_table(new_name)
6930    return AlterTable(
6931        this=old_table,
6932        actions=[
6933            RenameTable(this=new_table),
6934        ],
6935    )
6936
6937
6938def rename_column(
6939    table_name: str | Table,
6940    old_column_name: str | Column,
6941    new_column_name: str | Column,
6942    exists: t.Optional[bool] = None,
6943) -> AlterTable:
6944    """Build ALTER TABLE... RENAME COLUMN... expression
6945
6946    Args:
6947        table_name: Name of the table
6948        old_column: The old name of the column
6949        new_column: The new name of the column
6950        exists: Whether to add the `IF EXISTS` clause
6951
6952    Returns:
6953        Alter table expression
6954    """
6955    table = to_table(table_name)
6956    old_column = to_column(old_column_name)
6957    new_column = to_column(new_column_name)
6958    return AlterTable(
6959        this=table,
6960        actions=[
6961            RenameColumn(this=old_column, to=new_column, exists=exists),
6962        ],
6963    )
6964
6965
6966def convert(value: t.Any, copy: bool = False) -> Expression:
6967    """Convert a python value into an expression object.
6968
6969    Raises an error if a conversion is not possible.
6970
6971    Args:
6972        value: A python object.
6973        copy: Whether to copy `value` (only applies to Expressions and collections).
6974
6975    Returns:
6976        Expression: the equivalent expression object.
6977    """
6978    if isinstance(value, Expression):
6979        return maybe_copy(value, copy)
6980    if isinstance(value, str):
6981        return Literal.string(value)
6982    if isinstance(value, bool):
6983        return Boolean(this=value)
6984    if value is None or (isinstance(value, float) and math.isnan(value)):
6985        return null()
6986    if isinstance(value, numbers.Number):
6987        return Literal.number(value)
6988    if isinstance(value, bytes):
6989        return HexString(this=value.hex())
6990    if isinstance(value, datetime.datetime):
6991        datetime_literal = Literal.string(
6992            (value if value.tzinfo else value.replace(tzinfo=datetime.timezone.utc)).isoformat(
6993                sep=" "
6994            )
6995        )
6996        return TimeStrToTime(this=datetime_literal)
6997    if isinstance(value, datetime.date):
6998        date_literal = Literal.string(value.strftime("%Y-%m-%d"))
6999        return DateStrToDate(this=date_literal)
7000    if isinstance(value, tuple):
7001        return Tuple(expressions=[convert(v, copy=copy) for v in value])
7002    if isinstance(value, list):
7003        return Array(expressions=[convert(v, copy=copy) for v in value])
7004    if isinstance(value, dict):
7005        return Map(
7006            keys=Array(expressions=[convert(k, copy=copy) for k in value]),
7007            values=Array(expressions=[convert(v, copy=copy) for v in value.values()]),
7008        )
7009    raise ValueError(f"Cannot convert {value}")
7010
7011
7012def replace_children(expression: Expression, fun: t.Callable, *args, **kwargs) -> None:
7013    """
7014    Replace children of an expression with the result of a lambda fun(child) -> exp.
7015    """
7016    for k, v in tuple(expression.args.items()):
7017        is_list_arg = type(v) is list
7018
7019        child_nodes = v if is_list_arg else [v]
7020        new_child_nodes = []
7021
7022        for cn in child_nodes:
7023            if isinstance(cn, Expression):
7024                for child_node in ensure_collection(fun(cn, *args, **kwargs)):
7025                    new_child_nodes.append(child_node)
7026            else:
7027                new_child_nodes.append(cn)
7028
7029        expression.set(k, new_child_nodes if is_list_arg else seq_get(new_child_nodes, 0))
7030
7031
7032def replace_tree(
7033    expression: Expression,
7034    fun: t.Callable,
7035    prune: t.Optional[t.Callable[[Expression], bool]] = None,
7036) -> Expression:
7037    """
7038    Replace an entire tree with the result of function calls on each node.
7039
7040    This will be traversed in reverse dfs, so leaves first.
7041    If new nodes are created as a result of function calls, they will also be traversed.
7042    """
7043    stack = list(expression.dfs(prune=prune))
7044
7045    while stack:
7046        node = stack.pop()
7047        new_node = fun(node)
7048
7049        if new_node is not node:
7050            node.replace(new_node)
7051
7052            if isinstance(new_node, Expression):
7053                stack.append(new_node)
7054
7055    return new_node
7056
7057
7058def column_table_names(expression: Expression, exclude: str = "") -> t.Set[str]:
7059    """
7060    Return all table names referenced through columns in an expression.
7061
7062    Example:
7063        >>> import sqlglot
7064        >>> sorted(column_table_names(sqlglot.parse_one("a.b AND c.d AND c.e")))
7065        ['a', 'c']
7066
7067    Args:
7068        expression: expression to find table names.
7069        exclude: a table name to exclude
7070
7071    Returns:
7072        A list of unique names.
7073    """
7074    return {
7075        table
7076        for table in (column.table for column in expression.find_all(Column))
7077        if table and table != exclude
7078    }
7079
7080
7081def table_name(table: Table | str, dialect: DialectType = None, identify: bool = False) -> str:
7082    """Get the full name of a table as a string.
7083
7084    Args:
7085        table: Table expression node or string.
7086        dialect: The dialect to generate the table name for.
7087        identify: Determines when an identifier should be quoted. Possible values are:
7088            False (default): Never quote, except in cases where it's mandatory by the dialect.
7089            True: Always quote.
7090
7091    Examples:
7092        >>> from sqlglot import exp, parse_one
7093        >>> table_name(parse_one("select * from a.b.c").find(exp.Table))
7094        'a.b.c'
7095
7096    Returns:
7097        The table name.
7098    """
7099
7100    table = maybe_parse(table, into=Table, dialect=dialect)
7101
7102    if not table:
7103        raise ValueError(f"Cannot parse {table}")
7104
7105    return ".".join(
7106        (
7107            part.sql(dialect=dialect, identify=True, copy=False)
7108            if identify or not SAFE_IDENTIFIER_RE.match(part.name)
7109            else part.name
7110        )
7111        for part in table.parts
7112    )
7113
7114
7115def normalize_table_name(table: str | Table, dialect: DialectType = None, copy: bool = True) -> str:
7116    """Returns a case normalized table name without quotes.
7117
7118    Args:
7119        table: the table to normalize
7120        dialect: the dialect to use for normalization rules
7121        copy: whether to copy the expression.
7122
7123    Examples:
7124        >>> normalize_table_name("`A-B`.c", dialect="bigquery")
7125        'A-B.c'
7126    """
7127    from sqlglot.optimizer.normalize_identifiers import normalize_identifiers
7128
7129    return ".".join(
7130        p.name
7131        for p in normalize_identifiers(
7132            to_table(table, dialect=dialect, copy=copy), dialect=dialect
7133        ).parts
7134    )
7135
7136
7137def replace_tables(
7138    expression: E, mapping: t.Dict[str, str], dialect: DialectType = None, copy: bool = True
7139) -> E:
7140    """Replace all tables in expression according to the mapping.
7141
7142    Args:
7143        expression: expression node to be transformed and replaced.
7144        mapping: mapping of table names.
7145        dialect: the dialect of the mapping table
7146        copy: whether to copy the expression.
7147
7148    Examples:
7149        >>> from sqlglot import exp, parse_one
7150        >>> replace_tables(parse_one("select * from a.b"), {"a.b": "c"}).sql()
7151        'SELECT * FROM c /* a.b */'
7152
7153    Returns:
7154        The mapped expression.
7155    """
7156
7157    mapping = {normalize_table_name(k, dialect=dialect): v for k, v in mapping.items()}
7158
7159    def _replace_tables(node: Expression) -> Expression:
7160        if isinstance(node, Table):
7161            original = normalize_table_name(node, dialect=dialect)
7162            new_name = mapping.get(original)
7163
7164            if new_name:
7165                table = to_table(
7166                    new_name,
7167                    **{k: v for k, v in node.args.items() if k not in TABLE_PARTS},
7168                    dialect=dialect,
7169                )
7170                table.add_comments([original])
7171                return table
7172        return node
7173
7174    return expression.transform(_replace_tables, copy=copy)  # type: ignore
7175
7176
7177def replace_placeholders(expression: Expression, *args, **kwargs) -> Expression:
7178    """Replace placeholders in an expression.
7179
7180    Args:
7181        expression: expression node to be transformed and replaced.
7182        args: positional names that will substitute unnamed placeholders in the given order.
7183        kwargs: keyword arguments that will substitute named placeholders.
7184
7185    Examples:
7186        >>> from sqlglot import exp, parse_one
7187        >>> replace_placeholders(
7188        ...     parse_one("select * from :tbl where ? = ?"),
7189        ...     exp.to_identifier("str_col"), "b", tbl=exp.to_identifier("foo")
7190        ... ).sql()
7191        "SELECT * FROM foo WHERE str_col = 'b'"
7192
7193    Returns:
7194        The mapped expression.
7195    """
7196
7197    def _replace_placeholders(node: Expression, args, **kwargs) -> Expression:
7198        if isinstance(node, Placeholder):
7199            if node.name:
7200                new_name = kwargs.get(node.name)
7201                if new_name is not None:
7202                    return convert(new_name)
7203            else:
7204                try:
7205                    return convert(next(args))
7206                except StopIteration:
7207                    pass
7208        return node
7209
7210    return expression.transform(_replace_placeholders, iter(args), **kwargs)
7211
7212
7213def expand(
7214    expression: Expression,
7215    sources: t.Dict[str, Query],
7216    dialect: DialectType = None,
7217    copy: bool = True,
7218) -> Expression:
7219    """Transforms an expression by expanding all referenced sources into subqueries.
7220
7221    Examples:
7222        >>> from sqlglot import parse_one
7223        >>> expand(parse_one("select * from x AS z"), {"x": parse_one("select * from y")}).sql()
7224        'SELECT * FROM (SELECT * FROM y) AS z /* source: x */'
7225
7226        >>> expand(parse_one("select * from x AS z"), {"x": parse_one("select * from y"), "y": parse_one("select * from z")}).sql()
7227        'SELECT * FROM (SELECT * FROM (SELECT * FROM z) AS y /* source: y */) AS z /* source: x */'
7228
7229    Args:
7230        expression: The expression to expand.
7231        sources: A dictionary of name to Queries.
7232        dialect: The dialect of the sources dict.
7233        copy: Whether to copy the expression during transformation. Defaults to True.
7234
7235    Returns:
7236        The transformed expression.
7237    """
7238    sources = {normalize_table_name(k, dialect=dialect): v for k, v in sources.items()}
7239
7240    def _expand(node: Expression):
7241        if isinstance(node, Table):
7242            name = normalize_table_name(node, dialect=dialect)
7243            source = sources.get(name)
7244            if source:
7245                subquery = source.subquery(node.alias or name)
7246                subquery.comments = [f"source: {name}"]
7247                return subquery.transform(_expand, copy=False)
7248        return node
7249
7250    return expression.transform(_expand, copy=copy)
7251
7252
7253def func(name: str, *args, copy: bool = True, dialect: DialectType = None, **kwargs) -> Func:
7254    """
7255    Returns a Func expression.
7256
7257    Examples:
7258        >>> func("abs", 5).sql()
7259        'ABS(5)'
7260
7261        >>> func("cast", this=5, to=DataType.build("DOUBLE")).sql()
7262        'CAST(5 AS DOUBLE)'
7263
7264    Args:
7265        name: the name of the function to build.
7266        args: the args used to instantiate the function of interest.
7267        copy: whether to copy the argument expressions.
7268        dialect: the source dialect.
7269        kwargs: the kwargs used to instantiate the function of interest.
7270
7271    Note:
7272        The arguments `args` and `kwargs` are mutually exclusive.
7273
7274    Returns:
7275        An instance of the function of interest, or an anonymous function, if `name` doesn't
7276        correspond to an existing `sqlglot.expressions.Func` class.
7277    """
7278    if args and kwargs:
7279        raise ValueError("Can't use both args and kwargs to instantiate a function.")
7280
7281    from sqlglot.dialects.dialect import Dialect
7282
7283    dialect = Dialect.get_or_raise(dialect)
7284
7285    converted: t.List[Expression] = [maybe_parse(arg, dialect=dialect, copy=copy) for arg in args]
7286    kwargs = {key: maybe_parse(value, dialect=dialect, copy=copy) for key, value in kwargs.items()}
7287
7288    constructor = dialect.parser_class.FUNCTIONS.get(name.upper())
7289    if constructor:
7290        if converted:
7291            if "dialect" in constructor.__code__.co_varnames:
7292                function = constructor(converted, dialect=dialect)
7293            else:
7294                function = constructor(converted)
7295        elif constructor.__name__ == "from_arg_list":
7296            function = constructor.__self__(**kwargs)  # type: ignore
7297        else:
7298            constructor = FUNCTION_BY_NAME.get(name.upper())
7299            if constructor:
7300                function = constructor(**kwargs)
7301            else:
7302                raise ValueError(
7303                    f"Unable to convert '{name}' into a Func. Either manually construct "
7304                    "the Func expression of interest or parse the function call."
7305                )
7306    else:
7307        kwargs = kwargs or {"expressions": converted}
7308        function = Anonymous(this=name, **kwargs)
7309
7310    for error_message in function.error_messages(converted):
7311        raise ValueError(error_message)
7312
7313    return function
7314
7315
7316def case(
7317    expression: t.Optional[ExpOrStr] = None,
7318    **opts,
7319) -> Case:
7320    """
7321    Initialize a CASE statement.
7322
7323    Example:
7324        case().when("a = 1", "foo").else_("bar")
7325
7326    Args:
7327        expression: Optionally, the input expression (not all dialects support this)
7328        **opts: Extra keyword arguments for parsing `expression`
7329    """
7330    if expression is not None:
7331        this = maybe_parse(expression, **opts)
7332    else:
7333        this = None
7334    return Case(this=this, ifs=[])
7335
7336
7337def cast_unless(
7338    expression: ExpOrStr,
7339    to: DATA_TYPE,
7340    *types: DATA_TYPE,
7341    **opts: t.Any,
7342) -> Expression | Cast:
7343    """
7344    Cast an expression to a data type unless it is a specified type.
7345
7346    Args:
7347        expression: The expression to cast.
7348        to: The data type to cast to.
7349        **types: The types to exclude from casting.
7350        **opts: Extra keyword arguments for parsing `expression`
7351    """
7352    expr = maybe_parse(expression, **opts)
7353    if expr.is_type(*types):
7354        return expr
7355    return cast(expr, to, **opts)
7356
7357
7358def array(
7359    *expressions: ExpOrStr, copy: bool = True, dialect: DialectType = None, **kwargs
7360) -> Array:
7361    """
7362    Returns an array.
7363
7364    Examples:
7365        >>> array(1, 'x').sql()
7366        'ARRAY(1, x)'
7367
7368    Args:
7369        expressions: the expressions to add to the array.
7370        copy: whether to copy the argument expressions.
7371        dialect: the source dialect.
7372        kwargs: the kwargs used to instantiate the function of interest.
7373
7374    Returns:
7375        An array expression.
7376    """
7377    return Array(
7378        expressions=[
7379            maybe_parse(expression, copy=copy, dialect=dialect, **kwargs)
7380            for expression in expressions
7381        ]
7382    )
7383
7384
7385def tuple_(
7386    *expressions: ExpOrStr, copy: bool = True, dialect: DialectType = None, **kwargs
7387) -> Tuple:
7388    """
7389    Returns an tuple.
7390
7391    Examples:
7392        >>> tuple_(1, 'x').sql()
7393        '(1, x)'
7394
7395    Args:
7396        expressions: the expressions to add to the tuple.
7397        copy: whether to copy the argument expressions.
7398        dialect: the source dialect.
7399        kwargs: the kwargs used to instantiate the function of interest.
7400
7401    Returns:
7402        A tuple expression.
7403    """
7404    return Tuple(
7405        expressions=[
7406            maybe_parse(expression, copy=copy, dialect=dialect, **kwargs)
7407            for expression in expressions
7408        ]
7409    )
7410
7411
7412def true() -> Boolean:
7413    """
7414    Returns a true Boolean expression.
7415    """
7416    return Boolean(this=True)
7417
7418
7419def false() -> Boolean:
7420    """
7421    Returns a false Boolean expression.
7422    """
7423    return Boolean(this=False)
7424
7425
7426def null() -> Null:
7427    """
7428    Returns a Null expression.
7429    """
7430    return Null()
7431
7432
7433NONNULL_CONSTANTS = (
7434    Literal,
7435    Boolean,
7436)
7437
7438CONSTANTS = (
7439    Literal,
7440    Boolean,
7441    Null,
7442)